自动化助手数据结构-API 中心-腾讯云

AutomationAgentInfo

自动化助手客户端信息

被如下接口引用：DescribeAutomationAgentStatus。

名称	类型	描述
InstanceId	String	实例ID。示例值：ins-tatxxxyyy
Version	String	Agent 版本号。示例值：1.0.19
LastHeartbeatTime	Timestamp ISO8601	上次心跳时间示例值：2023-12-11T07:45:27Z
AgentStatus	String	Agent状态，取值范围： Online：在线，Offline：离线示例值：Online
Environment	String	Agent运行环境，取值范围：Linux：Linux实例Windows：Windows实例示例值：Linux
SupportFeatures	Array of String	Agent 支持的功能列表。示例值：["NEW_FEATURE"]

Command

命令详情。

被如下接口引用：DescribeCommands。

名称	类型	描述
CommandId	String	命令ID。示例值：cmd-aaaaaaaa
CommandName	String	命令名称。示例值：cmdname
Description	String	命令描述。示例值：the cmd
Content	String	Base64编码后的命令内容。示例值：bHMgMTIzCmVjaG8ge3tifX0ge3tjfX0=
CommandType	String	命令类型。示例值：SHELL
WorkingDirectory	String	命令执行路径。示例值：/root
Timeout	Integer	命令超时时间。示例值：60
CreatedTime	Timestamp ISO8601	命令创建时间。示例值：2021-05-12T02:49:04Z
UpdatedTime	Timestamp ISO8601	命令更新时间。示例值：2021-05-12T02:49:04Z
EnableParameter	Boolean	是否启用自定义参数功能。示例值：false
DefaultParameters	String	自定义参数的默认取值。示例值：{"varA": "222"}
DefaultParameterConfs	Array of DefaultParameterConf	自定义参数的默认取值。示例值：[ { "name": "test01", "value": "12345", "description": "for test01" }, { "name": "test02", "value": "12345", "description": "for test02" } ]
Scenes	Array of String	命令关联的场景示例值：["sc-12345678"]
FormattedDescription	String	命令的结构化描述。公共命令有值，用户命令为空字符串。示例值：{"cmd_description":{"en":"cmd1","zh-cn":"cmd1","name-
CreatedBy	String	命令创建者。TAT 代表公共命令，USER 代表个人命令。示例值：TAT
Tags	Array of Tag	命令关联的标签列表。示例值：[]
Username	String	在实例上执行命令的用户名。示例值：root
OutputCOSBucketUrl	String	日志上传的cos bucket 地址。示例值：https://BucketName-123454321.cos.ap-beijing.myqcloud.com
OutputCOSKeyPrefix	String	日志在cos bucket中的目录。示例值：aa/bb/cc

CommandDocument

命令执行详情。

被如下接口引用：DescribeInvocationTasks。

名称	类型	描述
Content	String	Base64 编码后的执行命令。示例值：cHdk
CommandType	String	命令类型。示例值：SHELL
Timeout	Integer	超时时间。示例值：60
WorkingDirectory	String	执行路径。示例值：/root
Username	String	执行用户。示例值：root
OutputCOSBucketUrl	String	保存输出的 COS Bucket 链接。示例值：https://<名称>-<AppId>.cos.ap-beijing.myqcloud.com
OutputCOSKeyPrefix	String	保存输出的文件名称前缀。示例值：agent

DefaultParameterConf

自定义参数。

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

名称	类型	必选	描述
ParameterName	String	是	参数名。示例值：name
ParameterValue	String	是	参数默认值。示例值：value
ParameterDescription	String	否	参数描述。示例值：This is a parameter.

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	是	需要过滤的字段。示例值：command-type
Values	Array of String	是	字段的过滤值。示例值：["POWERSHELL", "BAT"]

GeneralResourceQuotaSet

用户配额信息。

被如下接口引用：DescribeQuotas。

名称	类型	必选	描述
ResourceName	String	否	资源名称示例值：COMMAND
ResourceQuotaUsed	Integer	否	已使用额度示例值：200
ResourceQuotaTotal	Integer	否	总额度示例值：500

Invocation

执行活动详情。

被如下接口引用：DescribeInvocations。

名称	类型	描述
InvocationId	String	执行活动ID。示例值：inv-xxxxxxxx
CommandId	String	命令ID。示例值：cmd-xxxxxxxx
InvocationStatus	String	执行任务状态。取值范围： PENDING：等待下发 RUNNING：命令运行中 SUCCESS：命令成功 FAILED：命令失败 TIMEOUT：命令超时 PARTIAL_FAILED：命令部分失败 PARTIAL_CANCELLED：任务部分取消 CANCELLED：任务全部取消 CANCELLING：任务取消中示例值：SUCCESS
InvocationTaskBasicInfoSet	Array of InvocationTaskBasicInfo	执行任务信息列表。示例值：[ { "InstanceId": "lhins-71itjmdd", "InvocationTaskId": "invt-bd1w17gx22", "TaskStatus": "FAILED" } ], "OutputCOSBucketUrl": "", "OutputCOSKeyPrefix": "", "Parameters": "{}", "StartTime": "2024-11-13T00:20:32Z", "Timeout": 600, "UpdatedTime": "2024-11-13T00:20:32Z", "Username": "root", "WorkingDirectory": "/data" } ]
Description	String	执行活动描述。示例值：Test Invocation
StartTime	Timestamp ISO8601	执行活动开始时间。示例值：2014-08-03 12:00:00
EndTime	Timestamp ISO8601	执行活动结束时间。示例值：2014-08-03 12:00:00
CreatedTime	Timestamp ISO8601	执行活动创建时间。示例值：2014-08-03 12:00:00
UpdatedTime	Timestamp ISO8601	执行活动更新时间。示例值：2014-08-03 12:00:00
Parameters	String	自定义参数取值。示例值：{"varA": "222"}
DefaultParameters	String	自定义参数的默认取值。示例值：{"varA": "222"}
InstanceKind	String	执行命令的实例类型，取值范围：CVM、LIGHTHOUSE。示例值：CVM
Username	String	在实例上执行命令时使用的用户名。示例值：root
InvocationSource	String	调用来源。示例值：USER
CommandContent	String	base64编码的命令内容示例值：cHdk
CommandType	String	命令类型示例值：SHELL
Timeout	Integer	执行命令过期时间，单位秒示例值：60
WorkingDirectory	String	执行命令的工作路径示例值：/root
OutputCOSBucketUrl	String	日志上传的cos bucket 地址。示例值：https://BucketName-123454321.cos.ap-beijing.myqcloud.com
OutputCOSKeyPrefix	String	日志在cos bucket中的目录。示例值：aa/bb/cc

InvocationTask

执行任务。

被如下接口引用：DescribeInvocationTasks。

名称	类型	描述
InvocationId	String	执行活动ID。示例值：inv-xxxxxxxx
InvocationTaskId	String	执行任务ID。示例值：invt-xxxxxxxx
CommandId	String	命令ID。示例值：cmd-xxxxxxxx
TaskStatus	String	执行任务状态。取值范围： PENDING：等待下发 DELIVERING：下发中 DELIVER_DELAYED：延时下发 DELIVER_FAILED：下发失败 START_FAILED：命令启动失败 RUNNING：命令运行中 SUCCESS：命令成功 FAILED：命令执行失败，执行完退出码不为 0 TIMEOUT：命令超时 TASK_TIMEOUT：执行任务超时 CANCELLING：取消中 CANCELLED：已取消（命令启动前就被取消） TERMINATED：已中止（命令执行期间被取消）示例值：SUCCESS
InstanceId	String	实例ID。示例值：ins-xxxxxxxx
TaskResult	TaskResult	执行结果。示例值：{ "Dropped": 0, "ExecEndTime": "2024-11-13T02:10:32Z", "ExecStartTime": "2024-11-13T02:10:32Z", "ExitCode": 7, "Output": "", "OutputUploadCOSErrorInfo": "", "OutputUrl": "" }
StartTime	Timestamp ISO8601	执行任务开始时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2014-08-03 12:00:00
EndTime	Timestamp ISO8601	执行任务结束时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2014-08-03 12:00:00
CreatedTime	Timestamp ISO8601	创建时间。示例值：2014-08-03 12:00:00
UpdatedTime	Timestamp ISO8601	更新时间。示例值：2014-08-03 12:00:00
CommandDocument	CommandDocument	执行任务所执行的命令详情。示例值：{ "CommandType": "SHELL", "Content": "cHdk", "OutputCOSBucketUrl": "", "OutputCOSKeyPrefix": "prefix", "Timeout": 600, "Username": "root", "WorkingDirectory": "/data" }
ErrorInfo	String	执行任务失败时的错误信息。示例值：working_directory not exists
InvocationSource	String	调用来源。示例值：USER

InvocationTaskBasicInfo

执行活动任务简介。

被如下接口引用：DescribeInvocations。

名称	类型	描述
InvocationTaskId	String	执行任务ID。示例值：invt-aaaabbbb
TaskStatus	String	执行任务状态。取值范围： PENDING：等待下发 DELIVERING：下发中 DELIVER_DELAYED：延时下发 DELIVER_FAILED：下发失败 START_FAILED：命令启动失败 RUNNING：命令运行中 SUCCESS：命令成功 FAILED：命令执行失败，执行完退出码不为 0 TIMEOUT：命令超时 TASK_TIMEOUT：执行任务超时 CANCELLING：取消中 CANCELLED：已取消（命令启动前就被取消） TERMINATED：已中止（命令执行期间被取消）示例值：TERMINATED
InstanceId	String	实例ID。示例值：ins-aaaabbbb

Invoker

执行器信息。

被如下接口引用：DescribeInvokers。

名称	类型	描述
InvokerId	String	执行器ID。示例值：ivk-27yagap9
Name	String	执行器名称。示例值：invoker-test
Type	String	执行器类型。示例值：SCHEDULE
CommandId	String	命令ID。示例值：cmd-m7uma92n
Username	String	用户名。示例值：root
Parameters	String	自定义参数。示例值：{"var": 1}
InstanceIds	Array of String	实例ID列表。示例值：["ins-yx05ky8j"]
Enable	Boolean	执行器是否启用。示例值：true
ScheduleSettings	ScheduleSettings	执行器周期计划。周期执行器会返回此字段。注意：此字段可能返回 null，表示取不到有效值。
CreatedTime	Timestamp ISO8601	创建时间。示例值：2021-08-30T06:42:02Z
UpdatedTime	Timestamp ISO8601	修改时间。示例值：2021-08-30T06:42:02Z

InvokerRecord

执行器执行记录。

被如下接口引用：DescribeInvokerRecords。

名称	类型	描述
InvokerId	String	执行器ID。示例值：ivk-b7s3qa5l
InvokeTime	Timestamp ISO8601	执行时间。示例值：2021-10-30T00:00:00Z
Reason	String	执行原因。示例值：start an invocation at scheduled time.
InvocationId	String	命令执行ID。示例值：inv-4ybg8gmj
Result	String	触发结果。示例值：SUCCESS

RegionInfo

描述单个地域信息

被如下接口引用：DescribeRegions。

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

RegisterCodeInfo

注册码信息。

被如下接口引用：DescribeRegisterCodes。

名称	类型	描述
RegisterCodeId	String	注册码ID。示例值：d0b7xxxx-a6xx-40x9-898x-44c9f508axxx
Description	String	注册码描述。示例值：此注册码用于注册托管实例。
InstanceNamePrefix	String	注册实例名称前缀。示例值：register-test
RegisterLimit	Integer	该注册码允许注册的实例数目。示例值：100
ExpiredTime	Timestamp ISO8601	该注册码的过期时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-09-07T13:13:29Z
IpAddressRange	String	该注册码限制tat_agent只能从IpAddressRange所描述公网出口进行注册。示例值：133.12.234.0/24
Enabled	Boolean	该注册码是否可用。示例值：true
RegisteredCount	Integer	该注册码已注册数目。示例值：10
CreatedTime	Timestamp ISO8601	注册码创建时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-12-01 00:00:00
UpdatedTime	Timestamp ISO8601	注册码最近一次更新时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-12-01 00:00:00

RegisterInstanceInfo

注册实例信息。

被如下接口引用：DescribeRegisterInstances。

名称	类型	描述
RegisterCodeId	String	注册码ID。示例值：d0b7xxxx-a6xx-40x9-898x-44c9f508axxx
InstanceId	String	实例ID。示例值：rins-8d5cxxxx
InstanceName	String	实例名。示例值：register-test
MachineId	String	机器ID。示例值：00xxxxx-0fxx-xxxx-xxxx-33951xxxxxxx
SystemName	String	系统名。示例值：Linux
HostName	String	主机名。示例值：VM-0-01-ubuntu
LocalIp	String	内网IP。示例值：10.0.0.1
PublicKey	String	公钥。示例值：-----BEGIN RSA PUBLIC KEY-----\nXXXXX...
Status	String	托管状态。返回Online表示实例正在托管，返回Offline表示实例未托管。示例值：Online
CreatedTime	Timestamp ISO8601	创建时间。示例值：2023-12-01 00:00:00
UpdatedTime	Timestamp ISO8601	上次更新时间。示例值：2023-12-01 00:00:00

Scene

场景详情。

被如下接口引用：DescribeScenes。

名称	类型	必选	描述
SceneId	String	否	场景 ID 。示例值：sc-12345678
SceneName	String	否	场景名称。示例值：运维场景
CreatedBy	String	否	场景创建者。示例值：USER
CreatedTime	String	否	创建时间。示例值：2021-05-12T02:49:04Z
UpdatedTime	String	否	更新时间。示例值：2021-05-12T02:49:04Z

ScheduleSettings

周期执行器设置。

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

名称	类型	必选	描述
Policy	String	是	执行策略： ONCE：单次执行 RECURRENCE：周期执行示例值：ONCE
Recurrence	String	否	触发 Crontab 表达式。Policy 为 RECURRENCE 时，需要指定此字段。Crontab 按北京时间解析。示例值：0 0 1 * *
InvokeTime	Timestamp ISO8601	否	执行器下次执行时间。Policy 为 ONCE 时，需要指定此字段。示例值：2021-09-01T00:00:00+08:00

Tag

标签

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

名称	类型	必选	描述
Key	String	是	标签键。示例值：tag-key
Value	String	是	标签值。示例值：tag-value

TaskResult

任务结果。

被如下接口引用：DescribeInvocationTasks。

名称	类型	描述
ExitCode	Integer	命令执行ExitCode。示例值：0
Output	String	Base64编码后的命令输出。最大长度24KB。示例值：aGVsbG8sd29ybGQ=
ExecStartTime	Timestamp ISO8601	命令执行开始时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2014-08-03 12:00:00
ExecEndTime	Timestamp ISO8601	命令执行结束时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2014-08-03 12:00:00
Dropped	Integer	命令最终输出被截断的字节数。示例值：100
OutputUrl	String	日志在cos中的地址示例值：https://BucketName-123454321.cos.ap-beijing.myqcloud.com
OutputUploadCOSErrorInfo	String	日志上传cos的错误信息。示例值：Failed to upload output to cos

数据结构

本页目录：

AutomationAgentInfo

Command

CommandDocument

DefaultParameterConf

Filter

GeneralResourceQuotaSet

Invocation

InvocationTask

InvocationTaskBasicInfo

Invoker

InvokerRecord

RegionInfo

RegisterCodeInfo

RegisterInstanceInfo

Scene

ScheduleSettings

Tag

TaskResult