tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTaskStatus

Last updated: 2024-11-18 16:41:10

1. API Description

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

This API is used to query the execution status of an async task. After non-query APIs (for example, used to create/delete CLB instances) are called successfully, this API needs to be used to query whether the task is successful.

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: DescribeTaskStatus.
Version Yes String Common Params. The value used for this API: 2024-09-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TaskId No String Request ID, which is the RequestId parameter returned by the API.

3. Output Parameters

Parameter Name Type Description
Status Integer Current status of task. Valid values: 0 (succeeded), 1 (failed), 2 (in progress).
LoadBalancerIds Array of String Array of unique CLB instance IDs.

Note: This field may return null, indicating that no valid value can be obtained.
Message String Auxiliary description information, such as failure causes.
Note: This field may return null, indicating that no valid value can be obtained.
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 Querying the Status of an Async Task

Assuming the CLB creation API is called successfully and the returned RequestId is 55c85074-3e7f-4c6d-864f-673660d4f8de, it is necessary to query whether the async task was ultimately executed successfully. In the response, the Status 0 indicates the task was executed successfully.

Input Example

POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskStatus
<common request parameters>

{
    "TaskId": "55c85074-3e7f-4c6d-864f-673660d4f8de"
}

Output Example

{
    "Response": {
        "Status": 0,
        "LoadBalancerIds": [
            "gwlb-6efswuxa"
        ],
        "RequestId": "917384bc-5b8d-4b68-a0bc-a58f815e8e3b"
    }
}

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.
InvalidParameter.RegionNotFound InvalidParameter.RegionNotFound
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy