tencent cloud

Feedback

DescribeInvokerRecords

Last updated: 2023-03-14 16:55:46

1. API Description

Domain name for API request: tat.tencentcloudapi.com.

This API is used to query the execution history of an invoker.

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: DescribeInvokerRecords.
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. Up to 100 IDs are allowed.
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 records.
InvokerRecordSet Array of InvokerRecord Execution history of an invoker.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the execution history of an invoker

Input Example

POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInvokerRecords
<Common request parameters>

{
    "InvokerIds": [
        "ivk-b7s3qa5l"
    ],
    "Offset": 0,
    "Limit": 2
}

Output Example

{
    "Response": {
        "RequestId": "0398dcea-b3de-4ec9-8e78-976191e0a94f",
        "TotalCount": 1443,
        "InvokerRecordSet": [
            {
                "InvokerId": "ivk-b7s3qa5l",
                "Reason": "start an invocation at scheduled time.",
                "InvocationId": "inv-l9l4orf1",
                "Result": "SUCCESS",
                "InvokeTime": "2021-09-06T09:33:05Z"
            },
            {
                "InvokerId": "ivk-b7s3qa5l",
                "Reason": "start an invocation at scheduled time.",
                "InvocationId": "inv-7ojgezbd",
                "Result": "SUCCESS",
                "InvokeTime": "2021-09-06T09:30:05Z"
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InvalidInvokerId Invalid InvokerId.