InvokeCommandRequest (ecs20140526 3.1.10 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.ecs20140526.models.InvokeCommandRequest

public class InvokeCommandRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型类和说明

static class InvokeCommandRequest.InvokeCommandRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`InvokeCommandRequest.InvokeCommandRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`commandId` The ID of the command.
`String`	`containerId` The ID of the container.
`String`	`containerName` The name of the container.
`String`	`frequency` The schedule on which you want to run the command.
`List<String>`	`instanceId` The IDs of the instances on which you want to run the command.
`String`	`ownerAccount`
`Long`	`ownerId`
`Map<String,?>`	`parameters` The key-value pairs of the custom parameters that are passed in when the custom parameter feature is enabled.
`String`	`regionId` The region ID.
`String`	`repeatMode` Specifies how to run the command.
`String`	`resourceGroupId` The ID of the resource group to which you want to assign the command executions.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`List<InvokeCommandRequest.InvokeCommandRequestTag>`	`tag` The tags that you want to add.
`Boolean`	`timed` Specifies whether to run the command on a schedule.
`Long`	`timeout` The timeout period for the command execution.
`String`	`username` The username that you use to run the command on instances.
`String`	`windowsPasswordName` The name of the password that you use to run the command on Windows instances.

构造器概要

构造器
构造器和说明

InvokeCommandRequest()

构造器
构造器和说明
`InvokeCommandRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static InvokeCommandRequest`	`build(Map<String,?> map)`
`String`	`getCommandId()`
`String`	`getContainerId()`
`String`	`getContainerName()`
`String`	`getFrequency()`
`List<String>`	`getInstanceId()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`Map<String,?>`	`getParameters()`
`String`	`getRegionId()`
`String`	`getRepeatMode()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`List<InvokeCommandRequest.InvokeCommandRequestTag>`	`getTag()`
`Boolean`	`getTimed()`
`Long`	`getTimeout()`
`String`	`getUsername()`
`String`	`getWindowsPasswordName()`
`InvokeCommandRequest`	`setCommandId(String commandId)`
`InvokeCommandRequest`	`setContainerId(String containerId)`
`InvokeCommandRequest`	`setContainerName(String containerName)`
`InvokeCommandRequest`	`setFrequency(String frequency)`
`InvokeCommandRequest`	`setInstanceId(List<String> instanceId)`
`InvokeCommandRequest`	`setOwnerAccount(String ownerAccount)`
`InvokeCommandRequest`	`setOwnerId(Long ownerId)`
`InvokeCommandRequest`	`setParameters(Map<String,?> parameters)`
`InvokeCommandRequest`	`setRegionId(String regionId)`
`InvokeCommandRequest`	`setRepeatMode(String repeatMode)`
`InvokeCommandRequest`	`setResourceGroupId(String resourceGroupId)`
`InvokeCommandRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`InvokeCommandRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`InvokeCommandRequest`	`setTag(List<InvokeCommandRequest.InvokeCommandRequestTag> tag)`
`InvokeCommandRequest`	`setTimed(Boolean timed)`
`InvokeCommandRequest`	`setTimeout(Long timeout)`
`InvokeCommandRequest`	`setUsername(String username)`
`InvokeCommandRequest`	`setWindowsPasswordName(String windowsPasswordName)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - commandId
```
@NameInMap(value="CommandId")
public String commandId
```
    The ID of the command. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.
    
    > Common Cloud Assistant commands can be run based on the names. For more information, see [View and run common Cloud Assistant commands](~~429635~~).
  - containerId
```
@NameInMap(value="ContainerId")
public String containerId
```
    The ID of the container. Only 64-bit hexadecimal strings are supported. You can use container IDs that are prefixed with `docker://`, `containerd://`, or `cri-o://` to specify container runtimes.
    
    Note:
    
    * If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
    
    * If you specify this parameter, scripts can be run only on Linux instances on which the Cloud Assistant client of version 2.2.3.344 or later is installed.
    
    * For information about how to view the version of the Cloud Assistant client, see [Install the Cloud Assistant client](~~64921~~).
    
    * For information about how to update the version of the Cloud Assistant client, see [Upgrade or disable upgrades for the Cloud Assistant client](~~134383~~).
    
    * If you specify this parameter, the `Username` parameter that is specified in a request to call this operation and the `WorkingDir` parameter that is specified in a request to call the [CreateCommand](~~64844~~) operation do not take effect. You can run the command in the default working directory of the container only by using the default user of the container. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).
    
    * If you specify this parameter, only shell scripts can be run in Linux containers. You cannot specify a script interpreter by adding a command in a format that is similar to `#!/usr/bin/python` at the beginning of a script. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).
  - containerName
```
@NameInMap(value="ContainerName")
public String containerName
```
    The name of the container.
    
    Note:
    
    * If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
    
    * If you specify this parameter, scripts can be run only on Linux instances on which the Cloud Assistant client of version 2.2.3.344 or later is installed.
    
    * For information about how to view the version of the Cloud Assistant client, see [Install the Cloud Assistant client](~~64921~~).
    
    * For information about how to update the version of the Cloud Assistant client, see [Upgrade or disable upgrades for the Cloud Assistant client](~~134383~~).
    
    * If you specify this parameter, the `Username` parameter that is specified in a request to call this operation and the `WorkingDir` parameter that is specified in a request to call the [CreateCommand](~~64844~~) operation do not take effect. You can run the command in the default working directory of the container only by using the default user of the container. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).
    
    * If you specify this parameter, only shell scripts can be run in Linux containers. You cannot specify a script interpreter by adding a command in a format that is similar to `#!/usr/bin/python` at the beginning of a script. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).
  - frequency
```
@NameInMap(value="Frequency")
public String frequency
```
    The schedule on which you want to run the command. When you set the `Timed` parameter to `true`, you must specify this parameter. You can run a command at a fixed interval based on a rate expression, run the command only once at a specified time, or run the command at specific times based on a cron expression.
    
    * To run a command at a fixed interval, use a rate expression to specify the interval. You can specify an interval in seconds, minutes, hours, or days. This option is suitable when tasks need to be executed at a fixed interval. Specify the interval in the following format: `rate()`. For example, specify `rate(5m)` to run the command every 5 minutes. Take note of the following limits when you specify an interval:
    
    * The specified interval can range from 60 seconds to seven days and must be longer than the timeout period of the scheduled task.
    
    * The interval is the amount of time that elapsed between two consecutive executions. The interval is irrelevant to the amount of time that is required to run the command once. For example, you set the interval to 5 minutes, and the amount of time that is required to run the command once is 2 minutes to run the command each time. Each time the command is run, the system waits 3 minutes before the system reruns the command.
    
    * A task is not immediately executed after it is created. For example, you set the interval to 5 minutes and create a task to run the command. The task runs 5 minutes after it is created.
    
    * To run a command only once at a specified time, specify a point in time and a time zone. Specify the point in time in the following format: `at(yyyy-MM-dd HH:mm:ss )`, which indicates `at(Year-Month-Day Hour:Minute:Second )`. If you do not specify a time zone, the default time zone UTC is used. You can specify the time zone in the following formats:
    
    * The name of the time zone. Examples: `Asia/Shanghai` and `America/Los_Angeles`.
    
    * The time offset from GMT. Examples: `GMT+8:00` (UTC+8) and `GMT-7:00` (UTC-7). If you use the GMT format, do not pad leading zeros to the hour value.
    
    * The abbreviation of the time zone. Only UTC is supported.
    
    For example, to run a command only once at 13:15:30 on June 6, 2022 (Shanghai time), set the time to `at(2022-06-06 13:15:30 Asia/Shanghai)`. To run a command only once at 13:15:30 on June 6, 2022 (UTC-7), set the time to `at(2022-06-06 13:15:30 GMT-7:00)`.
    
    * To run a command at specific times, specify a cron expression. Specify the time in the following format: ` `, where the cron expression is in the ` ` format. The system calculates the execution times of the command based on the specified cron expression and time zone and runs the command as scheduled. If you do not specify a time zone, the system time zone of the instance on which you want to run the command is used. For more information about cron expressions, see [Cron expressions](~~64769~~). You can specify the time zone in the following formats:
    
    * The name of the time zone. Examples: `Asia/Shanghai` and `America/Los_Angeles`.
    
    * The time offset from GMT. Examples: `GMT+8:00` (UTC+8) and `GMT-7:00` (UTC-7). If you use the GMT format, do not pad leading zeros to the hour value.
    
    * The abbreviation of the time zone. Only UTC is supported.
    
    For example, to run a command at 10:15:00 every day in 2022 (Shanghai time), set the time to `0 15 10 ? * * 2022 Asia/Shanghai`. To run a command every 30 minutes from 10:00:00 to 11:30:00 every day in 2022 (UTC+8), set the time to `0 0/30 10-11 * * ? 2022 GMT +8:00`. To run a command every 5 minutes from 14:00:00 to 14:55:00 every October every two years starting from 2022 (UTC), set the time to `0 0/5 14 * 10 ? 2022/2 UTC`.
    
    **
    
    **Note** The interval is at least 10 seconds and cannot be shorter than the timeout period of scheduled executions.
  - instanceId
```
@NameInMap(value="InstanceId")
public List<String> instanceId
```
    The IDs of the instances on which you want to run the command. You can specify up to 50 instance IDs in each request.
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - parameters
```
@NameInMap(value="Parameters")
public Map<String,?> parameters
```
    The key-value pairs of the custom parameters that are passed in when the custom parameter feature is enabled. Number of custom parameters: 0 to 10.
    
    * Each key in a Map collection cannot be an empty string and can be up to 64 characters in length.
    
    * Values in a Map collection can be empty strings.
    
    * The size of the command after Base64 encoding, including the custom parameters and the original command content, cannot exceed 18 KB.
    
    * The custom parameter names that are specified by the Parameters parameter must be included in the custom parameter names that you specified when you created the command. You can use empty strings to represent the parameters that are not passed in.
    
    If you want to disable the custom parameter feature, you can leave this parameter empty.
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.
  - repeatMode
```
@NameInMap(value="RepeatMode")
public String repeatMode
```
    Specifies how to run the command. Valid values:
    
    * Once: immediately runs the command.
    
    * Period: runs the command on a schedule. If you set this parameter to `Period`, you must set the `Timed` parameter to true and specify the `Frequency` parameter.
    
    * NextRebootOnly: automatically runs the command the next time the instance starts.
    
    * EveryReboot: automatically runs the command every time the instance starts.
    
    Default value:
    
    * If you set the `Timed` parameter to false and do not specify the `Frequency` parameter, the default value of the RepeatMode parameter is `Once`.
    
    * If you set the `Timed` parameter to true and specify the `Frequency` parameter, `Period` is used as the value of the RepeatMode parameter regardless of whether you specify the RepeatMode parameter.
    
    Note:
    
    * If you set the RepeatMode parameter to `Period`, `NextRebootOnly`, or `EveryReboot`, you can call the [StopInvocation](~~64838~~) operation to stop the pending or scheduled execution of the command.
    
    * If you set the RepeatMode parameter to `Period` or `EveryReboot`, you can call the [DescribeInvocationResults](~~64845~~) operation and set the `IncludeHistory` parameter to true to view the results of previous scheduled executions.
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group to which you want to assign the command executions. Take note of the following items when you set this parameter:
    
    * The instances that are specified by the InstanceId parameter must belong to the specified resource group.
    
    * You can specify this parameter to call the [DescribeInvocations](~~64840~~) or [DescribeInvocationResults](~~64845~~) operation to query execution results in the specified resource group.
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - tag
```
@NameInMap(value="Tag")
public List<InvokeCommandRequest.InvokeCommandRequestTag> tag
```
    The tags that you want to add.
  - timed
```
@NameInMap(value="Timed")
public Boolean timed
```
    Specifies whether to run the command on a schedule. Valid values:
    
    * true: runs the command on the schedule that is specified by the `Frequency` parameter. The execution results of a command do not affect the next command execution.
    
    * false: runs the command only once.
    
    Default value: false.
  - timeout
```
@NameInMap(value="Timeout")
public Long timeout
```
    The timeout period for the command execution. Unit: seconds.
    
    * The timeout period cannot be less than 10 seconds.
    
    * If a command cannot be run because the process slows down or because a specific module or the Cloud Assistant client does not exist, a timeout error occurs. When an execution times out, the command process is forcibly terminated.
    
    * If you do not specify this parameter, the timeout period that is specified when the command is created prevails and
    
    * is used as the timeout period for the execution. The timeout period of the command is not modified.
  - username
```
@NameInMap(value="Username")
public String username
```
    The username that you use to run the command on instances.
    
    * For Linux instances, the root username is used.
    
    * For Windows instances, the System username is used.
    
    You can also specify other usernames that already exist on the instances to run the command. To ensure security, we recommend that you run Cloud Assistant commands as a regular user. For more information, see [Run Cloud Assistant commands as a regular user](~~203771~~).
  - windowsPasswordName
```
@NameInMap(value="WindowsPasswordName")
public String windowsPasswordName
```
    The name of the password that you use to run the command on Windows instances.
    
    If you do not want to use the default username System to run the command on Windows instances, you must specify the WindowsPasswordName and `Username` parameters. The password is stored in plaintext in the parameter repository of Operation Orchestration Service (OOS) to mitigate the risk of password leaks. Only the name of the password is passed in by using the WindowsPasswordName parameter. For more information, see [Manage encryption parameters](~~186828~~) and [Run Cloud Assistant commands as a regular user](~~203771~~).
    
    > If you use the root username for Linux instances or the System username for Windows instances to run the command, you do not need to specify the WindowsPasswordName parameter.
- 构造器详细资料
  - InvokeCommandRequest
```
public InvokeCommandRequest()
```
- 方法详细资料
  - build
```
public static InvokeCommandRequest build(Map<String,?> map)
                                  throws Exception
```
    抛出:
    
    Exception
  - setCommandId
```
public InvokeCommandRequest setCommandId(String commandId)
```
  - getCommandId
```
public String getCommandId()
```
  - setContainerId
```
public InvokeCommandRequest setContainerId(String containerId)
```
  - getContainerId
```
public String getContainerId()
```
  - setContainerName
```
public InvokeCommandRequest setContainerName(String containerName)
```
  - getContainerName
```
public String getContainerName()
```
  - setFrequency
```
public InvokeCommandRequest setFrequency(String frequency)
```
  - getFrequency
```
public String getFrequency()
```
  - setInstanceId
```
public InvokeCommandRequest setInstanceId(List<String> instanceId)
```
  - getInstanceId
```
public List<String> getInstanceId()
```
  - setOwnerAccount
```
public InvokeCommandRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public InvokeCommandRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setParameters
```
public InvokeCommandRequest setParameters(Map<String,?> parameters)
```
  - getParameters
```
public Map<String,?> getParameters()
```
  - setRegionId
```
public InvokeCommandRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setRepeatMode
```
public InvokeCommandRequest setRepeatMode(String repeatMode)
```
  - getRepeatMode
```
public String getRepeatMode()
```
  - setResourceGroupId
```
public InvokeCommandRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public InvokeCommandRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public InvokeCommandRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setTag
```
public InvokeCommandRequest setTag(List<InvokeCommandRequest.InvokeCommandRequestTag> tag)
```
  - getTag
```
public List<InvokeCommandRequest.InvokeCommandRequestTag> getTag()
```
  - setTimed
```
public InvokeCommandRequest setTimed(Boolean timed)
```
  - getTimed
```
public Boolean getTimed()
```
  - setTimeout
```
public InvokeCommandRequest setTimeout(Long timeout)
```
  - getTimeout
```
public Long getTimeout()
```
  - setUsername
```
public InvokeCommandRequest setUsername(String username)
```
  - getUsername
```
public String getUsername()
```
  - setWindowsPasswordName
```
public InvokeCommandRequest setWindowsPasswordName(String windowsPasswordName)
```
  - getWindowsPasswordName
```
public String getWindowsPasswordName()
```

类 InvokeCommandRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

commandId

containerId

containerName

frequency

instanceId

ownerAccount

ownerId

parameters

regionId

repeatMode

resourceGroupId

resourceOwnerAccount

resourceOwnerId

tag

timed

timeout

username

windowsPasswordName

构造器详细资料

InvokeCommandRequest

方法详细资料

build

setCommandId

getCommandId

setContainerId

getContainerId

setContainerName

getContainerName

setFrequency

getFrequency

setInstanceId

getInstanceId

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setParameters

getParameters

setRegionId

getRegionId

setRepeatMode

getRepeatMode

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setTag

getTag

setTimed

getTimed

setTimeout

getTimeout

setUsername

getUsername

setWindowsPasswordName

getWindowsPasswordName