Package com.tencentcloudapi.tat.v20201028.models

Class RunCommandRequest

    • Constructor Summary

      Constructors 
      Constructor Description
      RunCommandRequest()  
      RunCommandRequest​(RunCommandRequest 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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getCommandName()
      Get 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
      String getCommandType()
      Get 命令类型，目前支持取值：SHELL、POWERSHELL。默认：SHELL。
      String getContent()
      Get Base64编码后的命令内容，长度不可超过64KB。
      DefaultParameterConf[] getDefaultParameterConfs()
      Get 自定义参数数组。 如果 Parameters 未提供，将使用这里的默认值进行替换。 自定义参数最多20个。
      String getDefaultParameters()
      Get 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果 Parameters 未提供，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
      String getDescription()
      Get 命令描述。不超过120字符。
      Boolean getEnableParameter()
      Get 是否启用自定义参数功能。 一旦创建，此值不提供修改。 取值范围： true：启用 false：不启用 默认值：false。
      String[] getInstanceIds()
      Get 待执行命令的实例ID列表，上限200。支持实例类型： CVM LIGHTHOUSE
      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均为字符串型。 如果未提供该参数取值，将使用 DefaultParameters 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
      Boolean getSaveCommand()
      Get 是否保存命令，取值范围： true：保存 false：不保存 默认为 false。
      Tag[] getTags()
      Get 如果保存命令，可为命令设置标签。列表长度不超过10。
      Long getTimeout()
      Get 命令超时时间，默认60秒。取值范围[1, 86400]。
      String getUsername()
      Get 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。
      String getWorkingDirectory()
      Get 命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
      void setCommandName​(String CommandName)
      Set 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
      void setCommandType​(String CommandType)
      Set 命令类型，目前支持取值：SHELL、POWERSHELL。默认：SHELL。
      void setContent​(String Content)
      Set Base64编码后的命令内容，长度不可超过64KB。
      void setDefaultParameterConfs​(DefaultParameterConf[] DefaultParameterConfs)
      Set 自定义参数数组。 如果 Parameters 未提供，将使用这里的默认值进行替换。 自定义参数最多20个。
      void setDefaultParameters​(String DefaultParameters)
      Set 启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果 Parameters 未提供，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
      void setDescription​(String Description)
      Set 命令描述。不超过120字符。
      void setEnableParameter​(Boolean EnableParameter)
      Set 是否启用自定义参数功能。 一旦创建，此值不提供修改。 取值范围： true：启用 false：不启用 默认值：false。
      void setInstanceIds​(String[] InstanceIds)
      Set 待执行命令的实例ID列表，上限200。支持实例类型： CVM LIGHTHOUSE
      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均为字符串型。 如果未提供该参数取值，将使用 DefaultParameters 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
      void setSaveCommand​(Boolean SaveCommand)
      Set 是否保存命令，取值范围： true：保存 false：不保存 默认为 false。
      void setTags​(Tag[] Tags)
      Set 如果保存命令，可为命令设置标签。列表长度不超过10。
      void setTimeout​(Long Timeout)
      Set 命令超时时间，默认60秒。取值范围[1, 86400]。
      void setUsername​(String Username)
      Set 在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。
      void setWorkingDirectory​(String WorkingDirectory)
      Set 命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • RunCommandRequest

        public RunCommandRequest()

      • RunCommandRequest

        public RunCommandRequest​(RunCommandRequest 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.

    • Method Detail

      • getContent

        public String getContent()
        Get Base64编码后的命令内容，长度不可超过64KB。
        Returns:
        Content Base64编码后的命令内容，长度不可超过64KB。

      • setContent

        public void setContent​(String Content)
        Set Base64编码后的命令内容，长度不可超过64KB。
        Parameters:
        Content - Base64编码后的命令内容，长度不可超过64KB。

      • getInstanceIds

        public String[] getInstanceIds()
        Get 待执行命令的实例ID列表，上限200。支持实例类型：
      • CVM
      • LIGHTHOUSE
Returns:
InstanceIds 待执行命令的实例ID列表，上限200。支持实例类型：
  • CVM
  • LIGHTHOUSE
    • Parameters:
    InstanceIds - 待执行命令的实例ID列表，上限200。支持实例类型：
  • CVM
  • LIGHTHOUSE