public class InvokeCommandRequest extends AbstractModel
Constructor and Description |
---|
InvokeCommandRequest() |
InvokeCommandRequest(InvokeCommandRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
String |
getCommandId()
Get 待触发的命令ID。
|
String[] |
getInstanceIds()
Get 待执行命令的实例ID列表,上限100。
|
String |
getOutputCOSBucketUrl()
Get 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
|
String |
getOutputCOSKeyPrefix()
Get 指定日志在cos bucket中的目录,目录命名有如下规则:
1.
|
String |
getParameters()
Get Command 的自定义参数。字段类型为json encoded string。如:{\"varA\": \"222\"}。
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
如果未提供该参数取值,将使用 Command 的 DefaultParameters 进行替换。
自定义参数最多20个。
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
Long |
getTimeout()
Get 命令超时时间,取值范围[1, 86400]。默认以Command配置的Timeout执行。
|
String |
getUsername()
Get 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。若不填,默认以 Command 配置的 Username 执行。
|
String |
getWorkingDirectory()
Get 命令执行路径, 默认以Command配置的WorkingDirectory执行。
|
void |
setCommandId(String CommandId)
Set 待触发的命令ID。
|
void |
setInstanceIds(String[] InstanceIds)
Set 待执行命令的实例ID列表,上限100。
|
void |
setOutputCOSBucketUrl(String OutputCOSBucketUrl)
Set 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
|
void |
setOutputCOSKeyPrefix(String OutputCOSKeyPrefix)
Set 指定日志在cos bucket中的目录,目录命名有如下规则:
1.
|
void |
setParameters(String Parameters)
Set Command 的自定义参数。字段类型为json encoded string。如:{\"varA\": \"222\"}。
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
如果未提供该参数取值,将使用 Command 的 DefaultParameters 进行替换。
自定义参数最多20个。
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
void |
setTimeout(Long Timeout)
Set 命令超时时间,取值范围[1, 86400]。默认以Command配置的Timeout执行。
|
void |
setUsername(String Username)
Set 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。若不填,默认以 Command 配置的 Username 执行。
|
void |
setWorkingDirectory(String WorkingDirectory)
Set 命令执行路径, 默认以Command配置的WorkingDirectory执行。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public InvokeCommandRequest()
public InvokeCommandRequest(InvokeCommandRequest source)
public String getCommandId()
public void setCommandId(String CommandId)
CommandId
- 待触发的命令ID。public String[] getInstanceIds()
public void setInstanceIds(String[] InstanceIds)
InstanceIds
- 待执行命令的实例ID列表,上限100。public String getParameters()
public void setParameters(String Parameters)
Parameters
- Command 的自定义参数。字段类型为json encoded string。如:{\"varA\": \"222\"}。
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
如果未提供该参数取值,将使用 Command 的 DefaultParameters 进行替换。
自定义参数最多20个。
自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。public String getUsername()
public void setUsername(String Username)
Username
- 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。若不填,默认以 Command 配置的 Username 执行。public String getWorkingDirectory()
public void setWorkingDirectory(String WorkingDirectory)
WorkingDirectory
- 命令执行路径, 默认以Command配置的WorkingDirectory执行。public Long getTimeout()
public void setTimeout(Long Timeout)
Timeout
- 命令超时时间,取值范围[1, 86400]。默认以Command配置的Timeout执行。public String getOutputCOSBucketUrl()
public void setOutputCOSBucketUrl(String OutputCOSBucketUrl)
OutputCOSBucketUrl
- 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。public String getOutputCOSKeyPrefix()
public void setOutputCOSKeyPrefix(String OutputCOSKeyPrefix)
OutputCOSKeyPrefix
- 指定日志在cos bucket中的目录,目录命名有如下规则:
1. 可用数字、中英文和可见字符的组合,长度最多为60。
2. 用 / 分割路径,可快速创建子目录。
3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。Copyright © 2023. All rights reserved.