产品概述
产品优势
应用场景
访问管理
使用限制
Domain name for API request: tat.intl.tencentcloudapi.com.
This API is used to query invoker details.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeInvokers. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InvokerIds.N | No | Array of String | Executor ID list. The maximum per request is 100. Parameters must not be specified simultaneously InvokerIds and Filters. |
| Filters.N | No | Array of Filter | Filter criteria:. - invoker-id - String - required: no - (filter condition) filter by executor id. -command-id - String - required: no - (filter condition) filters commands by id. you can obtain the id through the DescribeCommands (query command details) api. - invoker-type - String - required: no - (filter condition) filter by the executor type. currently only support SCHEDULE. The maximum number of Filters per request is 10, and that of Filter.Values is 5. the InvokerIds and Filters parameters cannot be specified at the same time. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Offset | No | Integer | Offset. Default value: 0. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of matching invokers. |
| InvokerSet | Array of Invoker | Invoker information. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInvokers
<Common request parameters>
{
"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"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| InvalidParameter.ConflictParameter | Conflicting parameters. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.InconsistentID | Invalid ID format or inconsistent format in the array. |
| InvalidParameterValue.InvalidFilter | Invalid filter. |
| InvalidParameterValue.InvalidInvokerId | Invalid InvokerId. |
| InvalidParameterValue.LimitExceeded | Parameter limit exceeded. |
| InvalidParameterValue.TooLarge | Parameter value is too large. |
| InvalidParameterValue.TooSmall | Parameter value is too low. |
文档反馈