tencent cloud

自动化助手

文档自动化助手API 文档数据结构

数据结构

下载
聚焦模式
字号
最后更新时间： 2026-06-09 15:37:43

AutomationAgentInfo

自动化助手客户端信息

被如下接口引用：DescribeAutomationAgentStatus。

名称 类型 描述
InstanceId String 实例ID。
Version String Agent 版本号。
LastHeartbeatTime Timestamp ISO8601 上次心跳时间
AgentStatus String Agent状态，取值范围：
Online：在线，Offline：离线
Environment String Agent运行环境，取值范围：Linux：Linux实例Windows：Windows实例
SupportFeatures Array of String Agent 支持的功能列表。

Command

命令详情。

被如下接口引用：DescribeCommands。

名称 类型 描述
CommandId String

命令ID。
CommandName String

命令名称。
Description String

命令描述。
Content String

Base64编码后的命令内容。
CommandType String

命令类型。取值为 SHELL、POWERSHELL、BAT 之一。
WorkingDirectory String

命令执行路径。
Timeout Integer

命令超时时间。

单位：秒

指定 OutputCOSBucketUrl 参数时，超时时间将包含命令输出上传 COS 的耗时
CreatedTime Timestamp ISO8601

命令创建时间。格式为：YYYY-MM-DDThh:mm:ssZ
UpdatedTime Timestamp ISO8601

命令更新时间。格式为：YYYY-MM-DDThh:mm:ssZ
EnableParameter Boolean

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

自定义参数的默认取值。
DefaultParameterConfs Array of DefaultParameterConf

自定义参数的默认取值。
Scenes Array of String

命令关联的场景
FormattedDescription String

命令的结构化描述。公共命令有值，用户命令为空字符串。
CreatedBy String

命令创建者。

枚举值：

  • TAT： 公共命令
  • USER： 个人创建的命令
Tags Array of Tag

命令关联的标签列表。
Username String

在实例上执行命令的用户名。
OutputCOSBucketUrl String

日志上传的cos bucket 地址。
OutputCOSKeyPrefix String

日志在cos bucket中的目录。

CommandDocument

命令执行详情。

被如下接口引用：DescribeInvocationTasks。

名称 类型 描述
Content String Base64 编码后的执行命令。
CommandType String 命令类型。取值为 SHELL、POWERSHELL、BAT 之一。
Timeout Integer 超时时间。单位：秒。
WorkingDirectory String 执行路径。
Username String 执行用户。
OutputCOSBucketUrl String 保存输出的 COS Bucket 链接。
OutputCOSKeyPrefix String 保存输出的文件名称前缀。

DefaultParameterConf

自定义参数。

被如下接口引用：CreateCommand, DescribeCommands, ModifyCommand, RunCommand。

名称 类型 必选 描述
ParameterName String 是 参数名。
ParameterValue String 是 参数默认值。
ParameterDescription String 否 参数描述。

Filter

描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等

  • 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
  • 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

以DescribeCommands接口的Filters为例。若我们需要查询命令名称（command-name）为 “打印工作目录” 并且 命令类型（command-type）为 “POWERSHELL” 或者 “BAT” 时，可如下实现：

Filters.0.Name=command-name
&Filters.0.Values.0=打印工作目录

&Filters.1.Name=command-type
&Filters.1.Values.0=POWERSHELL
&Filters.1.Values.1=BAT

被如下接口引用：DescribeAutomationAgentStatus, DescribeCommands, DescribeInvocationTasks, DescribeInvocations, DescribeInvokers, DescribeRegisterInstances, DescribeScenes。

名称 类型 必选 描述
Name String 是 需要过滤的字段。
Values Array of String 是 字段的过滤值。

GeneralResourceQuotaSet

用户配额信息。

被如下接口引用：DescribeQuotas。

名称 类型 必选 描述
ResourceName String 否 资源名称

取值为：

- COMMAND：命令
- REGISTER_CODE：托管实例注册码
ResourceQuotaUsed Integer 否 已使用额度
ResourceQuotaTotal Integer 否 总额度

Invocation

执行活动详情。

被如下接口引用：DescribeInvocations。

名称 类型 描述
InvocationId String 执行活动ID。
CommandId String 命令ID。
CommandName String 执行的命令的名称
InvocationStatus String 执行任务状态。取值范围：

- PENDING：等待下发
- RUNNING：命令运行中
- CANCELLING：取消中
- SUCCESS：命令成功
- TIMEOUT：命令超时
- FAILED：命令失败
- CANCELLED：命令全部取消
- PARTIAL_FAILED：命令部分失败
- PARTIAL_CANCELLED：命令部分取消
InvocationTaskBasicInfoSet Array of InvocationTaskBasicInfo 执行任务信息列表。
Description String 执行活动描述。
StartTime Timestamp ISO8601 执行活动开始时间。格式为：YYYY-MM-DDThh:mm:ssZ
EndTime Timestamp ISO8601 执行活动结束时间。格式为：YYYY-MM-DDThh:mm:ssZ
注意：此字段可能返回 null，表示取不到有效值。
CreatedTime Timestamp ISO8601 执行活动创建时间。格式为：YYYY-MM-DDThh:mm:ssZ
UpdatedTime Timestamp ISO8601 执行活动更新时间。格式为：YYYY-MM-DDThh:mm:ssZ
Parameters String 自定义参数取值。
DefaultParameters String 自定义参数的默认取值。
InstanceKind String 执行命令的实例类型，取值范围：CVM、LIGHTHOUSE。
Username String 在实例上执行命令时使用的用户名。
InvocationSource String 调用来源。

- USER：来源于用户调用。
- INVOKER：来源于定时执行。
CommandContent String base64编码的命令内容
CommandType String 命令类型
Timeout Integer 执行命令过期时间， 单位秒
WorkingDirectory String 执行命令的工作路径
OutputCOSBucketUrl String 日志上传的cos bucket 地址。
OutputCOSKeyPrefix String 日志在cos bucket中的目录。

InvocationTask

执行任务。

被如下接口引用：DescribeInvocationTasks。

名称 类型 描述
InvocationId String 执行活动ID。
InvocationTaskId String 执行任务ID。
CommandId String 命令ID。
TaskStatus String 执行任务状态。取值范围：

- PENDING：等待下发
- DELIVERING：下发中
- DELIVER_DELAYED：延时下发
- DELIVER_FAILED：下发失败
- START_FAILED：命令启动失败
- RUNNING：命令运行中
- SUCCESS：命令成功
- FAILED：命令执行失败，执行完退出码不为 0
- TIMEOUT：命令超时
- TASK_TIMEOUT：客户端无响应
- CANCELLING：取消中
- CANCELLED：已取消（命令启动前就被取消）
- TERMINATED：已中止（命令执行期间被取消）
InstanceId String 实例ID。
TaskResult TaskResult 执行结果。
StartTime Timestamp ISO8601 执行任务开始时间。格式为：YYYY-MM-DDThh:mm:ssZ
注意：此字段可能返回 null，表示取不到有效值。
EndTime Timestamp ISO8601 执行任务结束时间。格式为：YYYY-MM-DDThh:mm:ssZ
注意：此字段可能返回 null，表示取不到有效值。
CreatedTime Timestamp ISO8601 创建时间。格式为：YYYY-MM-DDThh:mm:ssZ
UpdatedTime Timestamp ISO8601 更新时间。格式为：YYYY-MM-DDThh:mm:ssZ
CommandDocument CommandDocument 执行任务所执行的命令详情。
ErrorInfo String 执行任务失败时的错误信息。
InvocationSource String 调用来源。

- USER：来源于用户调用。
- INVOKER：来源于定时执行。
CommandName String 执行的命令的名称。

InvocationTaskBasicInfo

执行活动任务简介。

被如下接口引用：DescribeInvocations。

名称 类型 描述
InvocationTaskId String 执行任务ID。
TaskStatus String 执行任务状态。取值范围：

- PENDING：等待下发
- DELIVERING：下发中
- DELIVER_DELAYED：延时下发
- DELIVER_FAILED：下发失败
- START_FAILED：命令启动失败
- RUNNING：命令运行中
- SUCCESS：命令成功
- FAILED：命令执行失败，执行完退出码不为 0
- TIMEOUT：命令超时
- TASK_TIMEOUT：客户端无响应
- CANCELLING：取消中
- CANCELLED：已取消（命令启动前就被取消）
- TERMINATED：已中止（命令执行期间被取消）
InstanceId String 实例ID。

Invoker

执行器信息。

被如下接口引用：DescribeInvokers。

名称 类型 描述
InvokerId String 执行器ID。
Name String 执行器名称。
Type String 执行器类型。目前仅支持 SCHEDULE 一种。
CommandId String 命令ID。
Username String 用户名。
Parameters String 自定义参数。
InstanceIds Array of String 实例ID列表。
Enable Boolean 执行器是否启用。
ScheduleSettings ScheduleSettings 执行器周期计划。周期执行器会返回此字段。
CreatedTime Timestamp ISO8601 创建时间。格式为：YYYY-MM-DDThh:mm:ssZ
UpdatedTime Timestamp ISO8601 修改时间。格式为：YYYY-MM-DDThh:mm:ssZ
Tags Array of Tag 标签信息。

InvokerRecord

执行器执行记录。

被如下接口引用：DescribeInvokerRecords。

名称 类型 描述
InvokerId String 执行器ID。
InvokeTime Timestamp ISO8601 执行时间。格式为：YYYY-MM-DDThh:mm:ssZ
Reason String 执行原因。
InvocationId String 命令执行ID。
Result String 触发结果。

- PENDING：等待下发
- RUNNING：命令运行中
- CANCELLING：取消中
- SUCCESS：命令成功
- TIMEOUT：命令超时
- FAILED：命令失败
- CANCELLED：命令全部取消
- PARTIAL_FAILED：命令部分失败
- PARTIAL_CANCELLED：命令部分取消

RegionInfo

描述单个地域信息

被如下接口引用：DescribeRegions。

名称 类型 描述
Region String 地域名称，例如，ap-guangzhou
RegionName String 地域描述，例如: 广州
RegionState String 地域是否可用状态，AVAILABLE 代表可用，UNAVAILABLE 代表不可用。

RegisterCodeInfo

注册码信息。

被如下接口引用：DescribeRegisterCodes。

名称 类型 描述
RegisterCodeId String 注册码ID。
Description String 注册码描述。
InstanceNamePrefix String 注册实例名称前缀。
RegisterLimit Integer 该注册码允许注册的实例数目。
ExpiredTime Timestamp ISO8601 该注册码的过期时间，按照 ISO8601 标准表示，并且使用 UTC 时间。
格式为： YYYY-MM-DDThh:mm:ssZ。
注意：此字段可能返回 null，表示取不到有效值。
IpAddressRange String 该注册码限制tat_agent只能从IpAddressRange所描述公网出口进行注册。
Enabled Boolean 该注册码是否可用。
RegisteredCount Integer 该注册码已注册数目。
CreatedTime Timestamp ISO8601 注册码创建时间，按照 ISO8601 标准表示，并且使用 UTC 时间。
格式为： YYYY-MM-DDThh:mm:ssZ。
注意：此字段可能返回 null，表示取不到有效值。
UpdatedTime Timestamp ISO8601 注册码最近一次更新时间，按照 ISO8601 标准表示，并且使用 UTC 时间。
格式为： YYYY-MM-DDThh:mm:ssZ。
注意：此字段可能返回 null，表示取不到有效值。

RegisterInstanceInfo

注册实例信息。

被如下接口引用：DescribeRegisterInstances。

名称 类型 描述
RegisterCodeId String 注册码ID。
InstanceId String 托管实例ID。
InstanceName String 托管实例名。
MachineId String 机器ID。
SystemName String 系统名。取值：Linux
HostName String 主机名。
LocalIp String 内网IP。
PublicKey String 公钥。
Status String 托管状态。
返回Online表示实例正在托管，返回Offline表示实例未托管。
CreatedTime Timestamp ISO8601 创建时间。格式为：YYYY-MM-DDThh:mm:ssZ
UpdatedTime Timestamp ISO8601 上次更新时间。格式为：YYYY-MM-DDThh:mm:ssZ
Tags Array of Tag 标签

Scene

场景详情。

被如下接口引用：DescribeScenes。

名称 类型 必选 描述
SceneId String 否 场景 ID 。
SceneName String 否 场景名称。
CreatedBy String 否 场景创建者。

- TAT：公共场景
CreatedTime String 否 创建时间。格式为：YYYY-MM-DDThh:mm:ssZ
UpdatedTime String 否 更新时间。格式为：YYYY-MM-DDThh:mm:ssZ

ScheduleSettings

周期执行器设置。

被如下接口引用：CreateInvoker, DescribeInvokers, ModifyInvoker。

名称 类型 必选 描述
Policy String 是 执行策略：

- ONCE：单次执行
- RECURRENCE：周期执行
Recurrence String 否 触发 Crontab 表达式。Policy 为 RECURRENCE 时，需要指定此字段。Crontab 按北京时间解析。
InvokeTime Timestamp ISO8601 否 执行器下次执行时间。Policy 为 ONCE 时，需要指定此字段。

时间格式为：YYYY-MM-DDThh:mm:ssZ

Tag

标签

被如下接口引用：CreateCommand, CreateInvoker, DescribeCommands, DescribeInvokers, DescribeRegisterInstances, RunCommand。

名称 类型 必选 描述
Key String 是 标签键。
Value String 是 标签值。

TaskResult

任务结果。

被如下接口引用：DescribeInvocationTasks。

名称 类型 描述
ExitCode Integer 命令执行ExitCode。
Output String Base64编码后的命令输出。最大长度24KB。
ExecStartTime Timestamp ISO8601 命令执行开始时间。格式为：YYYY-MM-DDThh:mm:ssZ
注意：此字段可能返回 null，表示取不到有效值。
ExecEndTime Timestamp ISO8601 命令执行结束时间。格式为：YYYY-MM-DDThh:mm:ssZ
注意：此字段可能返回 null，表示取不到有效值。
Dropped Integer 命令最终输出被截断的字节数。
OutputUrl String 日志在cos中的地址
OutputUploadCOSErrorInfo String 日志上传cos的错误信息。
上一篇: 获取配额信息下一篇: 错误码

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈