DescribeTaskStatus

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-02-21 10:11:07

Download PDF

1. API Description

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

This API is used to query the execution status of an async task. After non-query APIs (used to create/delete CLB instances, listeners, or rules or to bind/unbind real servers) 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeTaskStatus.
Version	Yes	String	Common parameter. The value used for this API: 2018-03-17.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
TaskId	No	String	Request ID, i.e., the RequestId parameter returned by the API.
DealName	No	String	Order ID.

3. Output Parameters

Parameter Name	Type	Description
Status	Integer	Current status of a task. Value range: 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 values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the status of an async task

Assume that the API to create forwarding rules is invoked and the returned RequestId is 55c85074-3e7f-4c6d-864f-673660d4f8de. This is an async task, you can call DescribeTaskStatus to check the task result. If the Status returned is 0, the task is successful.

Input Example

https://clb.tencentcloudapi.com/?Action=DescribeTaskStatus
&TaskId=55c85074-3e7f-4c6d-864f-673660d4f8de
&<Common request parameters>

Output Example

{
  "Response": {
    "Status": 0,
    "LoadBalancerIds": [
      "lb-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

Tencent Cloud CLI 3.0

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.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages