Data Types

Last updated:2026-03-05 16:27:26

Data Types

Last updated: 2026-03-05 16:27:26

AutomationAgentInfo

TAT agent information

Used by actions: DescribeAutomationAgentStatus.

Name	Type	Description
InstanceId	String	Instance ID.
Version	String	Agent version.
LastHeartbeatTime	Timestamp ISO8601	Last heartbeat time
AgentStatus	String	Agent status. valid values:. Online: Online, Offline: Offline.
Environment	String	Agent execution environment. valid values: Linux: Linux instance. Windows: Windows instance.
SupportFeatures	Array of String	Features supported by the TAT agent.

Command

Command details.

Used by actions: DescribeCommands.

Name	Type	Description
CommandId	String	Command ID. .
CommandName	String	Command name. .
Description	String	Command description. .
Content	String	The Base64-encoded command content. .
CommandType	String	Command type. value is one of SHELL, POWERSHELL, BAT. .
WorkingDirectory	String	Command execution path. .
Timeout	Integer	Command timeout time. unit: seconds. when specifying the OutputCOSBucketUrl parameter, the timeout period includes the time taken to upload command output to COS. .
CreatedTime	Timestamp ISO8601	Command creation time. the format is YYYY-MM-DDThh:MM:ssZ. .
UpdatedTime	Timestamp ISO8601	Command last update time. format: YYYY-MM-DDThh:MM:ssZ. .
EnableParameter	Boolean	Whether to enable the custom parameter feature. .
DefaultParameters	String	Default value of custom parameter. .
DefaultParameterConfs	Array of DefaultParameterConf	Default value of custom parameters. .
Scenes	Array of String	Command association scenarios .
FormattedDescription	String	Structured description of the command. public commands have values, and user commands are empty strings. .
CreatedBy	String	Command creator. enumeration value: TAT: public command USER: personal creation command .
Tags	Array of Tag	Tag list associated with the command. .
Username	String	Username to run command on the instance. .
OutputCOSBucketUrl	String	The cos bucket address for log upload. .
OutputCOSKeyPrefix	String	Directory of logs in the cos bucket. .

CommandDocument

Command execution details.

Used by actions: DescribeInvocationTasks.

Name	Type	Description
Content	String	Base64-encoded command.
CommandType	String	Command type. value is one of SHELL, POWERSHELL, BAT.
Timeout	Integer	Timeout period. unit: seconds.
WorkingDirectory	String	Execution path.
Username	String	The user who executes the command.
OutputCOSBucketUrl	String	URL of the COS bucket to store the output
OutputCOSKeyPrefix	String	Prefix of the output file name

DefaultParameterConf

Custom parameter.

Used by actions: CreateCommand, DescribeCommands, ModifyCommand, RunCommand.

Name	Type	Required	Description
ParameterName	String	Yes	Parameter name.
ParameterValue	String	Yes	Default parameter value.
ParameterDescription	String	No	Parameter description.

Filter

Describes the key-value pair filter, which is used for conditional filtering queries. for example, filter by ID, name, and status.

if there are multiple Filters, the logical relationship between them is AND.
if there are multiple Values in the same Filter, the relationship between Values under the same Filter is logical OR.
Take the Filters of the DescribeCommands api as an example. if we need to query commands with the command-name "print working directory" and the command-type "POWERSHELL" or "BAT", it can be implemented as follows:.
```
Filters.0.Name=command-name
&Filters.0.Values.0=Print working directory.
```

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

Used by actions: DescribeAutomationAgentStatus, DescribeCommands, DescribeInvocationTasks, DescribeInvocations, DescribeInvokers, DescribeRegisterInstances, DescribeScenes.

Name	Type	Required	Description
Name	String	Yes	Field to be filtered.
Values	Array of String	Yes	Filter values of the field.

GeneralResourceQuotaSet

User quota information.

Used by actions: DescribeQuotas.

Name	Type	Required	Description
ResourceName	String	No	Resource name Value is:. - COMMAND: COMMAND. -REGISTER_CODE: managed instance registration code.
ResourceQuotaUsed	Integer	No	Used credit limit.
ResourceQuotaTotal	Integer	No	Total quota.

Invocation

Execution activity details.

Used by actions: DescribeInvocations.

Name	Type	Description
InvocationId	String	Execution activity ID.
CommandId	String	Command ID.
CommandName	String	Name of the executed command.
InvocationStatus	String	Execution task status. valid values:. -PENDING: waiting for distribution. - RUNNING: command RUNNING. -Canceling. -SUCCESS: command success. -TIMEOUT: command timeout. - FAILED: command FAILED. -CANCELLED: all commands canceled. -PARTIAL_FAILED: the command partially failed. -PARTIAL_CANCELLED: the command is partially canceled.
InvocationTaskBasicInfoSet	Array of InvocationTaskBasicInfo	Execution task information list.
Description	String	Execution activity description.
StartTime	Timestamp ISO8601	Execute the activity start time. the format is YYYY-MM-DDThh:MM:ssZ.
EndTime	Timestamp ISO8601	Execute activity end time. format: YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.
CreatedTime	Timestamp ISO8601	Execution activity createtime. format: YYYY-MM-DDThh:MM:ssZ.
UpdatedTime	Timestamp ISO8601	Update time of the execution activity. the format is YYYY-MM-DDThh:MM:ssZ.
Parameters	String	Values of custom parameters.
DefaultParameters	String	Default custom parameter value.
InstanceKind	String	Type of the instance executing the command. Valid values: `CVM`, `LIGHTHOUSE`.
Username	String	The user who executes the command on the instance.
InvocationSource	String	Invocation source. -USER: originate from user invocation. -INVOKER: originate from scheduled execution.
CommandContent	String	Base64-encoded command
CommandType	String	Command type
Timeout	Integer	Command timeout period, in seconds.
WorkingDirectory	String	Working directory for executing the command.
OutputCOSBucketUrl	String	The COS bucket URL for uploading logs.
OutputCOSKeyPrefix	String	The COS bucket directory where the logs are saved.

InvocationTask

Execution task.

Used by actions: DescribeInvocationTasks.

Name	Type	Description
InvocationId	String	Execution activity ID.
InvocationTaskId	String	Execution task ID.
CommandId	String	Command ID.
TaskStatus	String	Execution task status. valid values:. -PENDING: waiting for distribution. -DELIVERING: distributing. -DELIVER_DELAYED: delivery delay. -DELIVER_FAILED: delivery fail. -START_FAILED: command start failed. - RUNNING: command RUNNING. -SUCCESS: command success. -FAILED: command execution failed, exit code not 0. -TIMEOUT: command timeout. -TASK_TIMEOUT: client no response. -Canceling. - CANCELLED: canceled (command canceled before startup). -TERMINATED: suspended (canceled during command execution).
InstanceId	String	Instance ID.
TaskResult	TaskResult	Execution result.
StartTime	Timestamp ISO8601	Task start time. format: YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.
EndTime	Timestamp ISO8601	Task end time. format: YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.
CreatedTime	Timestamp ISO8601	Creation time. the format is YYYY-MM-DDThh:MM:ssZ.
UpdatedTime	Timestamp ISO8601	Update time. the format is YYYY-MM-DDThh:MM:ssZ.
CommandDocument	CommandDocument	Command details of the execution task.
ErrorInfo	String	Error message displayed when the execution task fails.
InvocationSource	String	Invocation source. -USER: originate from user invocation. -INVOKER: originate from scheduled execution.
CommandName	String	Name of the executed command.

InvocationTaskBasicInfo

Execution task description.

Used by actions: DescribeInvocations.

Name	Type	Description
InvocationTaskId	String	Execution task ID.
TaskStatus	String	Execution task status. valid values:. -PENDING: waiting for distribution. -DELIVERING: distributing. -DELIVER_DELAYED: delivery delay. -DELIVER_FAILED: delivery fail. -START_FAILED: command start failed. - RUNNING: command RUNNING. -SUCCESS: command success. -FAILED: command execution failed, exit code not 0. -TIMEOUT: command timeout. -TASK_TIMEOUT: client no response. -Canceling. - CANCELLED: canceled (command canceled before startup). -TERMINATED: suspended (canceled during command execution).
InstanceId	String	Instance ID.

Invoker

Invoker information.

Used by actions: DescribeInvokers.

Name	Type	Description
InvokerId	String	Invoker ID.
Name	String	Invoker name.
Type	String	Executor type. currently only support SCHEDULE.
CommandId	String	Command ID.
Username	String	Username.
Parameters	String	Custom parameters.
InstanceIds	Array of String	Instance ID list.
Enable	Boolean	Whether to enable the invoker.
ScheduleSettings	ScheduleSettings	Executor periodic schedule. recurring invoker will return this field.
CreatedTime	Timestamp ISO8601	Creation time. the format is YYYY-MM-DDThh:MM:ssZ.
UpdatedTime	Timestamp ISO8601	Last modified. the format is YYYY-MM-DDThh:MM:ssZ.

InvokerRecord

Execution history of the invoker.

Used by actions: DescribeInvokerRecords.

Name	Type	Description
InvokerId	String	Invoker ID.
InvokeTime	Timestamp ISO8601	Execution time. format: YYYY-MM-DDThh:MM:ssZ.
Reason	String	Execution reason.
InvocationId	String	Command execution ID.
Result	String	Trigger result. -PENDING: waiting for distribution. - RUNNING: command RUNNING. -Canceling. -SUCCESS: command success. -TIMEOUT: command timeout. - FAILED: command FAILED. -CANCELLED: all commands canceled. -PARTIAL_FAILED: the command partially failed. -PARTIAL_CANCELLED: the command is partially canceled.

RegionInfo

Information of a region.

Used by actions: DescribeRegions.

Name	Type	Description
Region	String	Region name, such as `ap-guangzhou`
RegionName	String	Region description, such as `Guangzhou`
RegionState	String	Region availability status. AVAILABLE indicates the region is AVAILABLE. UNAVAILABLE indicates the region is UNAVAILABLE.

RegisterCodeInfo

Used by actions: DescribeRegisterCodes.

Name	Type	Description
RegisterCodeId	String	Registration code ID.
Description	String	Describes the registration code.
InstanceNamePrefix	String	Prefix of the registered instance name.
RegisterLimit	Integer	The number of instances the registration code allows.
ExpiredTime	Timestamp ISO8601	The expiry date of the registration code is in ISO8601 standard representation and uses UTC time. The format is YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.
IpAddressRange	String	The registration code limits tat_agent to register only from the public outbound ip described by IpAddressRange.
Enabled	Boolean	Is the registration code available.
RegisteredCount	Integer	The number of registered registration codes.
CreatedTime	Timestamp ISO8601	Registration code creation time, represented as ISO8601 standard and using UTC time. The format is YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.
UpdatedTime	Timestamp ISO8601	Last update time of the registration code, as ISO8601 standard representation and using UTC time. The format is YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.

RegisterInstanceInfo

Used by actions: DescribeRegisterInstances.

Name	Type	Description
RegisterCodeId	String	Registration code ID.
InstanceId	String	Managed instance ID.
InstanceName	String	Managed instance name.
MachineId	String	Machine ID.
SystemName	String	System name. valid values: Linux
HostName	String	Host name.
LocalIp	String	Private network IP
PublicKey	String	Public key.
Status	String	Hosting status. Return Online means the instance is managed, return Offline means the instance is unhosted.
CreatedTime	Timestamp ISO8601	Creation time. the format is YYYY-MM-DDThh:MM:ssZ.
UpdatedTime	Timestamp ISO8601	Last update time. the format is YYYY-MM-DDThh:MM:ssZ.
Tags	Array of Tag	Tag.

Scene

Scenario details.

Used by actions: DescribeScenes.

Name	Type	Required	Description
SceneId	String	No	Scene ID.
SceneName	String	No	Scenario name.
CreatedBy	String	No	Scene creator. - TAT: public scenario.
CreatedTime	String	No	Creation time. the format is YYYY-MM-DDThh:MM:ssZ.
UpdatedTime	String	No	Update time. the format is YYYY-MM-DDThh:MM:ssZ.

ScheduleSettings

Settings of a scheduled invoker

Used by actions: CreateInvoker, DescribeInvokers, ModifyInvoker.

Name	Type	Required	Description
Policy	String	Yes	Execution policy. -ONCE: one-time execution. -RECURRENCE: execute periodically.
Recurrence	String	No	Trigger the crontab expression. This field is required if `Policy` is `RECURRENCE`. The crontab expression is parsed in UTC+8.
InvokeTime	Timestamp ISO8601	No	Next execution time of the executor. this field requires specifying when Policy is ONCE. The time format is YYYY-MM-DDThh:MM:ssZ.

Tag

Information on tags

Used by actions: CreateCommand, CreateInvoker, DescribeCommands, DescribeRegisterInstances, RunCommand.

Name	Type	Required	Description
Key	String	Yes	Tag key.
Value	String	Yes	Tag value.

TaskResult

Task result.

Used by actions: DescribeInvocationTasks.

Name	Type	Description
ExitCode	Integer	ExitCode of the execution.
Output	String	Base64-encoded command output. The maximum length is 24 KB.
ExecStartTime	Timestamp ISO8601	Command execution start time. the format is YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.
ExecEndTime	Timestamp ISO8601	Execution end time of the command. format: YYYY-MM-DDThh:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained.
Dropped	Integer	Dropped bytes of the command output.
OutputUrl	String	COS URL of the logs.
OutputUploadCOSErrorInfo	String	Error message for uploading logs to COS.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud

AutomationAgentInfo

Command

CommandDocument

DefaultParameterConf

Filter

GeneralResourceQuotaSet

Invocation

InvocationTask

InvocationTaskBasicInfo

Invoker

InvokerRecord

RegionInfo

RegisterCodeInfo

RegisterInstanceInfo

Scene

ScheduleSettings

Tag

TaskResult