Help & DocumentationTencentDB for MySQLAPI DocumentsCDB API 2017Instance APIQuery Price (Pay per Use)

Query Price (Pay per Use)

Last updated: 2018-04-27 16:49:56

PDF

Contents：

1. API Description

This API (InquiryCdbPriceHour) is used to query the price (pay-by-usage) of a certain cloud database instance type (unit: yuan/hour). You can query instance price by passing instance type, purchase quantity, memory size, hard disk size and availability zone ID.
You can also create a new instance using Create Instance (Pay-by-usage) API.
Domain for API request: cdb.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters are also needed when API is called. For more information, please refer to Common Request Parameters. The Action field for this API is InquiryCdbPriceHour.

Parameter Name Required Type Description
cdbType Yes String Instance specification. Both fixed specification and custom specification are supported. CUSTOM means custom specification. You can acquire values for fixed specifications using Query Supported Specifications API. Fixed specification type will become unavailable in the future. It is recommended to use custom specifications.
goodsNum Yes Int Number of instances. Default is 1, minimum is 1, and maximum is 10. You can acquire the number of instances that can be created using Query Supported Specifications (supporting custom availability zones and configurations) API
memory No Int Size of instance memory (unit: MB). This parameter is required if the value of cdbType is CUSTOM. This parameter will be ignored if the value of cdbType is an integer. You can use API Query Supported Specifications (supporting custom availability zones and configurations) to acquire creatable memory specifications
volume No Int Size of instance disk (unit: GB). This parameter is required if the value of cdbType is CUSTOM. This parameter will be ignored if the value of cdbType is an integer. You can use API Query Supported Specifications (supporting custom availability zones and configurations) to acquire supported disk range
zoneId No Int Availability zone ID. By default, the system will automatically select an availability zone. You can use API Query Supported Specifications (supporting custom availability zones and configurations) to acquire supported availability zones
instanceRole No String Instance type, default is master. Supported values​include: master - indicates master instance, dr - indicates disaster recovery instance, ro - indicates read-only instance
protectMode No Int Data copy method. Default is 0, supported values include: 0 - indicates asynchronous copy, 1 - indicates semi-synchronized copy, 2 - indicates strong synchronized copy. You can specify this parameter when querying master instances, while this parameter will be ignored when querying read-only instances or disaster recovery instances

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.
codeDesc String Error description
price Int Instance price (unit: cent (RMB)

4. Error Codes

The following error codes only include the business logic error codes for this API.

Error Code Error Message Error Description
9003 InvalidParameter Incorrect parameter
9006 InternalError Database internal error
9301 InvalidParameter Incorrect transaction parameter

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=InquiryCdbPrice
&<Common request parameters>
&cdbType=CUSTOM
&memory=1000
&volume=25
&goodsNum=1
&zoneId=100003

Output

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "price": 35
}