命令ID。
*/ CommandId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisableInvoker请求参数结构体 */ export interface DisableInvokerRequest { /** * 待停止的执行器ID。 可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。 */ InvokerId: string; } /** * 注册实例信息。 */ export interface RegisterInstanceInfo { /** * 注册码ID。 */ RegisterCodeId?: string; /** * 托管实例ID。 */ InstanceId?: string; /** * 托管实例名。 */ InstanceName?: string; /** * 机器ID。 */ MachineId?: string; /** * 系统名。取值：Linux | Windows。 */ SystemName?: string; /** * 主机名。 */ HostName?: string; /** * 内网IP。 */ LocalIp?: string; /** * 公钥。 */ PublicKey?: string; /** * 托管状态。 返回Online表示实例正在托管，返回Offline表示实例未托管。 */ Status?: string; /** * 创建时间。格式为：YYYY-MM-DDThh:mm:ssZ */ CreatedTime?: string; /** * 上次更新时间。格式为：YYYY-MM-DDThh:mm:ssZ */ UpdatedTime?: string; /** * 标签 */ Tags?: Array命令脚本内容。 需 Base64 编码后传入。
当 EnableParameter = true 时，支持两种动态参数占位符：
echo {{word}} 配合参数 {"word": "hello"}，实际执行 echo hello，执行记录显示 {"word": "hello"}。echo {{tat-hidden:word}} 配合参数 {"word": "hello"}（传参 Key 不带前缀），实际执行 echo hello，记录显示 {"word": "******"}。参数格式：Base64 编码字符串
入参限制：Base64 编码后的字符串长度不能超过 64KB
*/ Content: string; /** *待执行命令的实例ID列表，上限200。
可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：
命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
*/ CommandName?: string; /** *命令描述。不超过120字符。
*/ Description?: string; /** *命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。
*/ CommandType?: string; /** *命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
*/ WorkingDirectory?: string; /** *命令超时时间，默认60秒。取值范围[1, 86400]。
*/ Timeout?: number; /** *是否保存命令，取值范围：
是否启用自定义参数功能。
一旦创建，此值不提供修改。
取值范围：
启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。
key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。
仅在命令的 EnableParameter 为 true 时，才允许设置此参数。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
如果 Parameters 未提供，将使用这里的默认值进行替换。
自定义参数最多20个。
自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
自定义参数数组。 如果 Parameters 未提供，将使用这里的默认值进行替换。 自定义参数最多20个。
如果 Parameters 未提供，将使用这里的默认值进行替换。
仅在命令的 EnableParameter 为 true 时，才允许设置此参数。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
Command 的自定义参数。字段类型为json encoded string。如：{"varA": "222"}。
key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。
仅在命令的 EnableParameter 为 true 时，才允许设置此参数。
如果未提供该参数取值，将使用 DefaultParameters 或 DefaultParameterConfs 进行替换。
自定义参数最多20个。
自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
如果保存命令，可为命令设置标签。列表长度不超过10。
*/ Tags?: Array在 CVM 或 Lighthouse 实例中执行命令的用户名称。
使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。
指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
*/ OutputCOSBucketUrl?: string; /** *指定日志在cos bucket中的目录，目录命名有如下规则：
命令ID。可通过 DescribeCommands(查询命令详情) 接口获取。
*/ CommandId: string; /** *命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
*/ CommandName?: string; /** *命令描述。不超过120字符。
*/ Description?: string; /** *命令脚本内容。 需 Base64 编码后传入。
当 EnableParameter = true 时，支持两种动态参数占位符：
echo {{word}} 配合参数 {"word": "hello"}，实际执行 echo hello，执行记录显示 {"word": "hello"}。echo {{tat-hidden:word}} 配合参数 {"word": "hello"}（传参 Key 不带前缀），实际执行 echo hello，记录显示 {"word": "******"}。参数格式：Base64 编码字符串
入参限制：Base64 编码后的字符串长度不能超过 64KB
*/ Content?: string; /** *命令类型，目前支持取值：SHELL、POWERSHELL、BAT。
*/ CommandType?: string; /** *命令执行路径。
*/ WorkingDirectory?: string; /** *命令超时时间。
取值范围：[1, 86400]
单位：秒
默认值：60
指定 OutputCOSBucketUrl 参数时，超时时间将包含命令输出上传 COS 的耗时
*/ Timeout?: number; /** *启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
采取整体全覆盖式修改，即修改时必须提供所有新默认值。
仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。
key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。
自定义参数最多20个。
自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。
自定义参数最多20个。
在 CVM 或 Lighthouse 实例中执行命令的用户名称。
使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。
指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
*/ OutputCOSBucketUrl?: string; /** *指定日志在cos bucket中的目录，目录命名有如下规则：
命令ID。
*/ CommandId?: string; /** *命令名称。
*/ CommandName?: string; /** *命令描述。
*/ Description?: string; /** *Base64编码后的命令内容。
*/ Content?: string; /** *命令类型。取值为 SHELL、POWERSHELL、BAT 之一。
*/ CommandType?: string; /** *命令执行路径。
*/ WorkingDirectory?: string; /** *命令超时时间。
单位：秒
指定 OutputCOSBucketUrl 参数时，超时时间将包含命令输出上传 COS 的耗时
*/ Timeout?: number; /** *命令创建时间。格式为：YYYY-MM-DDThh:mm:ssZ
*/ CreatedTime?: string; /** *命令更新时间。格式为：YYYY-MM-DDThh:mm:ssZ
*/ UpdatedTime?: string; /** *是否启用自定义参数功能。
*/ EnableParameter?: boolean; /** *自定义参数的默认取值。
*/ DefaultParameters?: string; /** *自定义参数的默认取值。
*/ DefaultParameterConfs?: Array命令关联的场景
*/ Scenes?: Array命令的结构化描述。公共命令有值，用户命令为空字符串。
*/ FormattedDescription?: string; /** *命令创建者。
枚举值：
命令关联的标签列表。
*/ Tags?: Array在实例上执行命令的用户名。
*/ Username?: string; /** *日志上传的cos bucket 地址。
*/ OutputCOSBucketUrl?: string; /** *日志在cos bucket中的目录。
*/ OutputCOSKeyPrefix?: string; } /** * PreviewReplacedCommandContent请求参数结构体 */ export interface PreviewReplacedCommandContentRequest { /** * 本次预览采用的自定义参数。字段类型为 json encoded string，如：{"varA": "222"}。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果有设置过 DefaultParameters 或 DefaultParameterConfs，会与 Parameters 进行叠加，优先使用 Parameters 的值。 key 为自定义参数名称，value 为该参数的取值。kv 均为字符串型。 自定义参数最多 20 个。 自定义参数名称需符合以下规范：字符数目上限 64，可选范围【a-zA-Z0-9-_】。 如果将预览的 CommandId 设置过 DefaultParameters，本参数可以为空。 */ Parameters?: string; /** * 要进行替换预览的命令。 可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 CommandId 与 Content，必须且只能提供一个。 */ CommandId?: string; /** * 要预览的命令内容，经 Base64 编码，长度不可超过 64KB。 CommandId 与 Content，必须且只能提供一个。 */ Content?: string; } /** * 执行任务。 */ export interface InvocationTask { /** * 执行活动ID。 */ InvocationId?: string; /** * 执行任务ID。 */ InvocationTaskId?: string; /** * 命令ID。 */ CommandId?: string; /** * 执行任务状态。取值范围： - PENDING：等待下发 - DELIVERING：下发中 - DELIVER_DELAYED：延时下发 - DELIVER_FAILED：下发失败 - START_FAILED：命令启动失败 - RUNNING：命令运行中 - SUCCESS：命令成功 - FAILED：命令执行失败，执行完退出码不为 0 - TIMEOUT：命令超时 - TASK_TIMEOUT：客户端无响应 - CANCELLING：取消中 - CANCELLED：已取消（命令启动前就被取消） - TERMINATED：已中止（命令执行期间被取消） */ TaskStatus?: string; /** * 实例ID。 */ InstanceId?: string; /** * 执行结果。 */ TaskResult?: TaskResult; /** * 执行任务开始时间。格式为：YYYY-MM-DDThh:mm:ssZ 注意：此字段可能返回 null，表示取不到有效值。 */ StartTime?: string; /** * 执行任务结束时间。格式为：YYYY-MM-DDThh:mm:ssZ 注意：此字段可能返回 null，表示取不到有效值。 */ EndTime?: string; /** * 创建时间。格式为：YYYY-MM-DDThh:mm:ssZ */ CreatedTime?: string; /** * 更新时间。格式为：YYYY-MM-DDThh:mm:ssZ */ UpdatedTime?: string; /** * 执行任务所执行的命令详情。 */ CommandDocument?: CommandDocument; /** * 执行任务失败时的错误信息。 */ ErrorInfo?: string; /** * 调用来源。 - USER：来源于用户调用。 - INVOKER：来源于定时执行。 */ InvocationSource?: string; /** * 执行的命令的名称。 */ CommandName?: string; } /** * ModifyInvoker返回参数结构体 */ export interface ModifyInvokerResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyRegisterInstance返回参数结构体 */ export interface ModifyRegisterInstanceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 执行器执行记录。 */ export interface InvokerRecord { /** * 执行器ID。 */ InvokerId?: string; /** * 执行时间。格式为：YYYY-MM-DDThh:mm:ssZ */ InvokeTime?: string; /** * 执行原因。 */ Reason?: string; /** * 命令执行ID。 */ InvocationId?: string; /** * 触发结果。 - PENDING：等待下发 - RUNNING：命令运行中 - CANCELLING：取消中 - SUCCESS：命令成功 - TIMEOUT：命令超时 - FAILED：命令失败 - CANCELLED：命令全部取消 - PARTIAL_FAILED：命令部分失败 - PARTIAL_CANCELLED：命令部分取消 */ Result?: string; } /** * DescribeRegisterCodes返回参数结构体 */ export interface DescribeRegisterCodesResponse { /** * 查询到的注册码总数。 */ TotalCount?: number; /** * 注册码信息列表。 */ RegisterCodeSet?: Array命令ID。
*/ CommandId?: string; /** *执行活动ID。
*/ InvocationId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisableRegisterCodes返回参数结构体 */ export interface DisableRegisterCodesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeQuotas返回参数结构体 */ export interface DescribeQuotasResponse { /** * 资源额度列表 */ GeneralResourceQuotaSet?: Array命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
*/ CommandName: string; /** *命令脚本内容。 需 Base64 编码后传入。
当 EnableParameter = true 时，支持两种动态参数占位符：
echo {{word}} 配合参数 {"word": "hello"}，实际执行 echo hello，执行记录显示 {"word": "hello"}。echo {{tat-hidden:word}} 配合参数 {"word": "hello"}（传参 Key 不带前缀），实际执行 echo hello，记录显示 {"word": "******"}。参数格式：Base64 编码字符串
入参限制：Base64 编码后的字符串长度不能超过 64KB
*/ Content: string; /** *命令描述。不超过120字符。
*/ Description?: string; /** *命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。
*/ CommandType?: string; /** *命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
*/ WorkingDirectory?: string; /** *命令超时时间，默认60秒。取值范围[1, 86400]。
*/ Timeout?: number; /** *是否启用自定义参数功能。
一旦创建，此值不提供修改。
默认值：false。
启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。
key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。
如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
仅在 EnableParameter 参数为 true 时，才允许设置此参数。
自定义参数最多20个。
自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
自定义参数数组。
如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
仅在 EnableParameter 参数为 true 时，才允许设置此参数。
自定义参数最多20个。
为命令关联的标签，列表长度不超过10。
*/ Tags?: Array在 CVM 或 Lighthouse 实例中执行命令的用户名称。
使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。
指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
*/ OutputCOSBucketUrl?: string; /** *指定日志在cos bucket中的目录，目录命名有如下规则：