tencent cloud

APIs

DescribeAsyncJobs

Download
Focus Mode
Font Size
Last updated: 2026-09-28 14:17:44

1. API Description

Domain name for API request: alb.intl.tencentcloudapi.com.

Query API for async tasks

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: DescribeAsyncJobs.
Version Yes String Common Params. The value used for this API: 2025-10-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
MaxResults No Integer Number of entries displayed each time during a batch query. Value range: 1–100. Default value: 20.
NextToken No String Whether there is a token for the next query. Value: not required for the first query or when there is no next query. If there is a next query, the value is the NextToken returned from the last API call.
RequestIds.N No Array of String List of RequestIds returned for async requests

3. Output Parameters

Parameter Name Type Description
Jobs Array of Job Task list.
MaxResults Integer Entry number displayed each time during batch query.
NextToken String Whether it has the token for the next query. Value: If NextToken is empty, there is no next query. If NextToken has a return value, this value indicates the token for starting the next query.
TotalCount Integer Number of list entries.
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.

4. Example

Example1 This API is used to query the async task information.

Input Example

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

{
    "RequestIds": [
        "c318a537-9bfa-40c2-b6d5-e6f872ad4b1f"
    ]
}

Output Example

{
    "Response": {
        "Jobs": [
            {
                "ApiName": "DisassociateBandwidthPackageFromLoadBalancer",
                "RequestId": "c318a537-9bfa-40c2-b6d5-e6f872ad4b1f",
                "ResourceIds": [
                    "alb-f8q2xk9m"
                ],
                "Status": "Succeeded"
            }
        ],
        "MaxResults": 20,
        "NextToken": "",
        "TotalCount": 1,
        "RequestId": "e4bf85e4-739f-4a3e-9ce1-d98d1fa2a876"
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Parameters are missing.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation The operation is not supported.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback