接口请求域名： tat.intl.tencentcloudapi.com 。
此接口用于查询自动化助手客户端的状态。
默认接口请求频率限制：60次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAutomationAgentStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceIds.N | 否 | Array of String | 待查询的实例ID列表。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 每次请求的上限为 100。 参数不支持同时指定 InstanceIds 和 Filters 。 |
| Filters.N | 否 | Array of Filter | - agent-status - String - 是否必填：否 -（过滤条件）按照agent状态过滤，取值：Online 在线，Offline 离线。 - environment - String - 是否必填：否 -（过滤条件）按照agent运行环境查询，取值：Linux, Windows。 - instance-id - String - 是否必填：否 -（过滤条件）按照实例ID过滤。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 每次请求的 Filters 的上限为10， Filter.Values 的上限为5。参数不支持同时指定 InstanceIds 和 Filters 。 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
| Offset | 否 | Integer | 偏移量，默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AutomationAgentSet | Array of AutomationAgentInfo | Agent 信息列表。 |
| TotalCount | Integer | 符合条件的 Agent 总数。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAutomationAgentStatus
<公共请求参数>
{
"InstanceIds": [
"lhins-ar5wyn4x"
]
}
{
"Response": {
"RequestId": "520e7b93-904d-44de-a2dd-8e4c545be4ce",
"AutomationAgentSet": [
{
"InstanceId": "lhins-ar5wyn4x",
"Version": "0.1.0",
"LastHeartbeatTime": "2020-11-16T12:05:44+00:00",
"AgentStatus": "Online",
"Environment": "Linux",
"SupportFeatures": [
"SESSION_MANAGER"
]
}
],
"TotalCount": 1
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ConflictParameter | 参数冲突。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidFilter | Filter 无效。 |
| InvalidParameterValue.InvalidInstanceId | 实例ID无效。 |
| InvalidParameterValue.LimitExceeded | 超过参数限制。 |
| UnauthorizedOperation.CamAuthFailed | CAM鉴权失败。 |
| UnauthorizedOperation.InvalidToken | Token 无效。 |
| UnauthorizedOperation.MFAExpired | Multi-Factor Authentication(MFA) 过期。 |
| UnauthorizedOperation.MFANotFound | Multi-Factor Authentication(MFA) 不存在。 |
| UnsupportedOperation | 操作不支持。 |
文档反馈