DescribeDBInstanceDeal

Last updated: 2025-12-03 10:42:08

DescribeDBInstanceDeal

Last updated: 2025-12-03 10:42:08

1. API Description

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

This API is used to get order details of purchase, renewal, and specification adjustment of a MongoDB instance.

A maximum of 5 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: DescribeDBInstanceDeal.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
DealId	Yes	String	Order ID. - Pay-as-you-go instance. It can be obtained through the output parameter DealId of the CreateDBInstanceHour API. - Yearly/monthly subscription instance. It can be obtained through the output parameter DealId of the CreateDBInstance API.

3. Output Parameters

Parameter Name	Type	Description
Status	Integer	Order status. - 1: unpaid. - 2: paid. - 3: delivering. - 4: delivered successfully. - 5: delivery failed. - 6: refund. - 7: order closed. - 8: closed due to unpaid timeout.
OriginalPrice	Float	Original price of the order, in USD.
DiscountPrice	Float	Discount price of the order, in USD.
Action	String	Order operation behavior. - purchase: newly purchased. - renew: renewed. - upgrade: configuration upgraded. - downgrade: configuration downgraded. - refund: return and refund.
InstanceId	String	Instance ID of the current order.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying order details

Input Example

https://mongodb.intl.tencentcloudapi.com/?Action=DescribeDBInstanceDeal
&DealId=20200420111635
&<Common request parameters>

Output Example

{
    "Response": {
        "Action": "purchase",
        "DiscountPrice": 759.33,
        "OriginalPrice": 1116.67,
        "RequestId": "e79836e8-1864-45bf-aa63-0c7af31e7de5",
        "Status": 4
    }
}

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
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud