tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAsyncRequestInfo

Last updated: 2024-01-30 10:25:36

    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.

    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: DescribeAsyncRequestInfo.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    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 task

    Input Example

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

{
    "AsyncRequestId": "f96e4f3c-8fc96c86-2ec79ac8-cb63a7a7"
}

    Output Example

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

    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
    CdbError.TaskError Backend task error.
    InternalError.FtpError File transfer exception
    InternalError.UndefinedError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InvalidAsyncRequestId The async task does not exist.
    OperationDenied Operation denied.
    OperationDenied.UserHasNoStrategy This account is not authorized to access the requested resource.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy