Class: TencentCloud::Tat::V20201028::InvokeCommandRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20201028/models.rb

Overview

InvokeCommand请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(commandid = nil, instanceids = nil, parameters = nil, username = nil, workingdirectory = nil, timeout = nil, outputcosbucketurl = nil, outputcoskeyprefix = nil) ⇒ InvokeCommandRequest

Returns a new instance of InvokeCommandRequest.



1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/v20201028/models.rb', line 1936

def initialize(commandid=nil, instanceids=nil, parameters=nil, username=nil, workingdirectory=nil, timeout=nil, outputcosbucketurl=nil, outputcoskeyprefix=nil)
  @CommandId = commandid
  @InstanceIds = instanceids
  @Parameters = parameters
  @Username = username
  @WorkingDirectory = workingdirectory
  @Timeout = timeout
  @OutputCOSBucketUrl = outputcosbucketurl
  @OutputCOSKeyPrefix = outputcoskeyprefix
end

Instance Attribute Details

#CommandId ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def CommandId
  @CommandId
end

#InstanceIds ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def InstanceIds
  @InstanceIds
end

#OutputCOSBucketUrl ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def OutputCOSBucketUrl
  @OutputCOSBucketUrl
end

#OutputCOSKeyPrefix ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def OutputCOSKeyPrefix
  @OutputCOSKeyPrefix
end

#Parameters ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def Parameters
  @Parameters
end

#Timeout ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def Timeout
  @Timeout
end

#Username ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def Username
  @Username
end

#WorkingDirectory ⇒ Object

可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：

  • CVM
  • Lighthouse
  • TAT 托管实例 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。
  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。

Parameters:

  • Parameters: —

    Command 的自定义参数。字段类型为json encoded string。如："222"。

  • Username: —

    在 CVM 或 Lighthouse 实例中执行命令的用户名称。

  • WorkingDirectory: —

    命令执行路径, 默认以Command配置的WorkingDirectory执行。

  • Timeout: —

    命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。

  • OutputCOSBucketUrl: —

    指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。

  • OutputCOSKeyPrefix: —

    指定日志在cos bucket中的目录，目录命名有如下规则：



1934
1935
1936
 
# File 'lib/v20201028/models.rb', line 1934

def WorkingDirectory
  @WorkingDirectory
end

Instance Method Details

#deserialize(params) ⇒ Object 



1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
 
# File 'lib/v20201028/models.rb', line 1947

def deserialize(params)
  @CommandId = params['CommandId']
  @InstanceIds = params['InstanceIds']
  @Parameters = params['Parameters']
  @Username = params['Username']
  @WorkingDirectory = params['WorkingDirectory']
  @Timeout = params['Timeout']
  @OutputCOSBucketUrl = params['OutputCOSBucketUrl']
  @OutputCOSKeyPrefix = params['OutputCOSKeyPrefix']
end