Class: TencentCloud::Tat::V20201028::CreateCommandRequest

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

Overview

CreateCommand请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(commandname = nil, content = nil, description = nil, commandtype = nil, workingdirectory = nil, timeout = nil, enableparameter = nil, defaultparameters = nil, defaultparameterconfs = nil, tags = nil, username = nil, outputcosbucketurl = nil, outputcoskeyprefix = nil) ⇒ CreateCommandRequest

Returns a new instance of CreateCommandRequest.



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/v20201028/models.rb', line 289

def initialize(commandname=nil, content=nil, description=nil, commandtype=nil, workingdirectory=nil, timeout=nil, enableparameter=nil, defaultparameters=nil, defaultparameterconfs=nil, tags=nil, username=nil, outputcosbucketurl=nil, outputcoskeyprefix=nil)
  @CommandName = commandname
  @Content = content
  @Description = description
  @CommandType = commandtype
  @WorkingDirectory = workingdirectory
  @Timeout = timeout
  @EnableParameter = enableparameter
  @DefaultParameters = defaultparameters
  @DefaultParameterConfs = defaultparameterconfs
  @Tags = tags
  @Username = username
  @OutputCOSBucketUrl = outputcosbucketurl
  @OutputCOSKeyPrefix = outputcoskeyprefix
end

Instance Attribute Details

#CommandName ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def CommandName
  @CommandName
end

#CommandType ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def CommandType
  @CommandType
end

#Content ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def Content
  @Content
end

#DefaultParameterConfs ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def DefaultParameterConfs
  @DefaultParameterConfs
end

#DefaultParameters ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def DefaultParameters
  @DefaultParameters
end

#Description ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def Description
  @Description
end

#EnableParameter ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def EnableParameter
  @EnableParameter
end

#OutputCOSBucketUrl ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def OutputCOSBucketUrl
  @OutputCOSBucketUrl
end

#OutputCOSKeyPrefix ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def OutputCOSKeyPrefix
  @OutputCOSKeyPrefix
end

#Tags ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def Tags
  @Tags
end

#Timeout ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def Timeout
  @Timeout
end

#Username ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def Username
  @Username
end

#WorkingDirectory ⇒ Object

一旦创建，此值不提供修改。 默认值：false。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

Parameters:

  • CommandName: —

    命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。

  • Content: —

    Base64编码后的命令内容，长度不可超过64KB。

  • Description: —

    命令描述。不超过120字符。

  • CommandType: —

    命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。

  • WorkingDirectory: —

    命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:Program Files\qcloud\tat_agent\workdir。

  • Timeout: —

    命令超时时间，默认60秒。取值范围[1, 86400]。

  • EnableParameter: —

    是否启用自定义参数功能。

  • DefaultParameters: —

    启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如："222"。

  • DefaultParameterConfs: —

    自定义参数数组。

  • Tags: —

    为命令关联的标签，列表长度不超过10。

  • Username: —

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

  • OutputCOSBucketUrl: —

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

  • OutputCOSKeyPrefix: —

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



287
288
289
 
# File 'lib/v20201028/models.rb', line 287

def WorkingDirectory
  @WorkingDirectory
end

Instance Method Details

#deserialize(params) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/v20201028/models.rb', line 305

def deserialize(params)
  @CommandName = params['CommandName']
  @Content = params['Content']
  @Description = params['Description']
  @CommandType = params['CommandType']
  @WorkingDirectory = params['WorkingDirectory']
  @Timeout = params['Timeout']
  @EnableParameter = params['EnableParameter']
  @DefaultParameters = params['DefaultParameters']
  unless params['DefaultParameterConfs'].nil?
    @DefaultParameterConfs = []
    params['DefaultParameterConfs'].each do |i|
      defaultparameterconf_tmp = DefaultParameterConf.new
      defaultparameterconf_tmp.deserialize(i)
      @DefaultParameterConfs << defaultparameterconf_tmp
    end
  end
  unless params['Tags'].nil?
    @Tags = []
    params['Tags'].each do |i|
      tag_tmp = Tag.new
      tag_tmp.deserialize(i)
      @Tags << tag_tmp
    end
  end
  @Username = params['Username']
  @OutputCOSBucketUrl = params['OutputCOSBucketUrl']
  @OutputCOSKeyPrefix = params['OutputCOSKeyPrefix']
end