Help & DocumentationTencentDB for MySQLAPI DocumentsTask APIDescribeAsyncRequestInfo

DescribeAsyncRequestInfo

Last updated: 2020-03-23 14:59:01

PDF

Contents：

1. API Description

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

This API (DescribeAsyncRequestInfo) is used to query the async task execution result of a TencentDB instance.

A maximum of 40 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: cdb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeAsyncRequestInfo.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
AsyncRequestId Yes String Async task request ID.

3. Output Parameters

Parameter Name Type Description
Status String Task execution result. Valid values: INITIAL, RUNNING, SUCCESS, FAILED, KILLED, REMOVED, PAUSED.
Note: This field may return null, indicating that no valid values can be obtained.
Info String Task execution information.
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 Execution Result of an Async Tasks

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeAsyncRequestInfo
&AsyncRequestId=f96e4f3c-8fc96c86-2ec79ac8-cb63a7a7
&<common request parameters>

Output Example

{
  "Response": {
    "Info": "Dropped database table successfully",
    "Status": "SUCCESS",
    "RequestId": "faae8d6a-38fb-44de-988e-5a0e78aba4a7"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
CdbError.TaskError Backend task error.
InvalidParameter Parameter error.
InvalidParameter.InvalidAsyncRequestId The async task does not exist.
OperationDenied The operation is denied.