1. API Description
Domain name for API request: tat.tencentcloudapi.com.
This API is used to query invoker details.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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 | No | String | Common Params. This parameter is not required for this API. |
| InvokerIds.N | No | Array of String | List of invoker IDs. |
| Filters.N | No | Array of Filter | Filter conditions:invoker-id - String - Required: No - (Filter condition) Filter by the invoker ID.command-id - String - Required: No - (Filter condition) Filter by the command ID.type - String - Required: No - (Filter condition) Filter by the invoker type. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Offset | No | Integer | Offset. Default value: 0. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of matching invokers. |
| InvokerSet | Array of Invoker | Invoker information. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying invokers
Input Example
POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInvokers
<Common request parameters>
{
"Filters": [
{
"Name": "invoker-id",
"Values": [
"ivk-b7s3qa5l"
]
}
]
}
Output Example
{
"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": "ONCE",
"Recurrence": "",
"InvokeTime": ""
},
"CreatedTime": "2021-08-30T06:42:02Z",
"UpdatedTime": "2021-09-09T12:07:00Z"
}
]
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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.InvalidFilter | Invalid filter. |
| InvalidParameterValue.InvalidInvokerId | Invalid InvokerId. |
Yes
No
Was this page helpful?