Documentation|Tencent Cloud

Recent Pages

DescribeDBInstanceDeal

Last updated: 2020-07-31 11:03:13

1. API Description

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

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

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

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 parameter. The value used for this API: DescribeDBInstanceDeal.
Version	Yes	String	Common parameter. The value used for this API: 2019-07-25.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
DealId	Yes	String	Order ID. It is returned by the `CreateDBInstance` and other APIs.

3. Output Parameters

Parameter Name	Type	Description
Status	Integer	Order status. Valid values: 1 (unpaid), 2 (paid), 3 (delivering), 4 (delivered), 5 (delivery failed), 6 (refunded), 7 (order closed), 8 (order closed because it failed to be paid within timeout period).
OriginalPrice	Float	Original price of the order.
DiscountPrice	Float	Discounted price of the order.
Action	String	Operation performed by the order. Valid values: purchase, renew, upgrade, downgrade, refund.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying order details

Input Example

https://mongodb.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

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.