tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAsyncRequestInfo

Last updated: 2023-03-20 10:55:12

1. API Description

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

This API is used to query async task status.

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: DescribeAsyncRequestInfo.
Version Yes String Common Params. The value used for this API: 2019-07-25.
Region No String Common Params. This parameter is not required for this API.
AsyncRequestId Yes String Async task ID, which is returned by APIs related to async tasks, such as CreateBackupDBInstance.

3. Output Parameters

Parameter Name Type Description
Status String Status. Valid values: initial (initializing), running, paused (paused due to failure), undoed (rolled back due to failure), failed (ended due to failure), success
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying async task status

Input Example

https://mongodb.tencentcloudapi.com/?Action=DescribeAsyncRequestInfo
&AsyncRequestId=4762
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "e600a8d0-9014-11ea-84c1-01cccde830c6",
        "Status": "success"
    }
}

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
InternalError Internal error
InvalidParameter.PermissionDenied The current subaccount has no permission to perform this operation.
InvalidParameterValue.StatusAbnormal The instance is in a status where operations are not allowed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy