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.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com
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 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 |
| Parameter Name | Type | Description |
|---|---|---|
| Status | Integer | Current status of a task. Value range: 0 (succeeded), 1 (failed), 2 (in progress). |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query whether an async task is successfully executed if the call to the forwarding rule creating API is returned successfully and the returned RequestId is 55c85074-3e7f-4c6d-864f-673660d4f8de. The Status value of 0 in the response indicates that the task succeeded.
https://clb.tencentcloudapi.com/?Action=DescribeTaskStatus
&TaskId=55c85074-3e7f-4c6d-864f-673660d4f8de
&<common request parameters>{
"Response": {
"Status": 0,
"RequestId": "917384bc-5b8d-4b68-a0bc-a58f815e8e3b"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?