1. 接口描述
接口请求域名: tat.tencentcloudapi.com 。
此接口用于查询自动化助手客户端的状态。
默认接口请求频率限制:60次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAutomationAgentStatus。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 否 | Array of String | 待查询的实例ID列表。 示例值:["lhins-ar5wyn4x"] |
Filters.N | 否 | Array of Filter | 过滤条件。 每次请求的 Filters 的上限为10, Filter.Values 的上限为5。参数不支持同时指定 InstanceIds 和 Filters 。 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值:10 |
Offset | 否 | Integer | 偏移量,默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AutomationAgentSet | Array of AutomationAgentInfo | Agent 信息列表。 |
TotalCount | Integer | 符合条件的 Agent 总数。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询客户端状态
输入示例
POST / HTTP/1.1
Host: tat.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
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
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 | 操作不支持。 |