接口请求域名： tat.intl.tencentcloudapi.com 。
此接口用于查询执行器信息。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInvokers。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InvokerIds.N | 否 | Array of String | 执行器 ID 列表。 每次请求的上限为 100。 参数不支持同时指定 InvokerIds 和 Filters 。 |
| Filters.N | 否 | Array of Filter | 过滤条件： - invoker-id - String - 是否必填：否 - （过滤条件）按执行器ID过滤。 - command-id - String - 是否必填：否 - （过滤条件）按命令ID过滤。可通过 DescribeCommands(查询命令详情) 接口获取。 - invoker-type - String - 是否必填：否 - （过滤条件）按执行器类型过滤。目前仅支持 SCHEDULE 一种。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。参数不支持同时指定 InvokerIds 和 Filters 。 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。 |
| Offset | 否 | Integer | 偏移量，默认为0。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 满足条件的执行器数量。 |
| InvokerSet | Array of Invoker | 执行器信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInvokers
<公共请求参数>
{
"Filters": [
{
"Name": "invoker-id",
"Values": [
"ivk-b7s3qa5l"
]
}
]
}
{
"Response": {
"RequestId": "a4c828cf-31c9-42d2-a558-2ad340a76ef0",
"TotalCount": 1,
"InvokerSet": [
{
"InvokerId": "ivk-b7s3qa5l",
"Name": "test-invoker",
"Type": "SCHEDULE",
"CommandId": "cmd-m7uma92n",
"Username": "root",
"Parameters": "{\"var\": \"1\"}",
"InstanceIds": [
"ins-yx05ky8j"
],
"Enable": false,
"ScheduleSettings": {
"Policy": "SCHEDULE",
"Recurrence": "0 0 1 * *",
"InvokeTime": "2021-08-30T06:42:02Z"
},
"CreatedTime": "2021-08-30T06:42:02Z",
"UpdatedTime": "2021-09-09T12:07:00Z"
}
]
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InvalidParameter.ConflictParameter | 参数冲突。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InconsistentID | ID 数组中，ID 格式错误或格式不一致。 |
| InvalidParameterValue.InvalidFilter | Filter 无效。 |
| InvalidParameterValue.InvalidInvokerId | InvokerId 无效。 |
| InvalidParameterValue.LimitExceeded | 超过参数限制。 |
| InvalidParameterValue.TooLarge | 参数取值过大。 |
| InvalidParameterValue.TooSmall | 参数取值过小。 |
文档反馈