1. API Description
Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This interface (DescribeInstanceSpecs) is used to query the instance specifications available for purchase on the query purchase page.
A maximum of 100 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.
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: DescribeInstanceSpecs. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-01-07. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DbType |
Yes |
String |
Database type. Valid values: MYSQL |
| IncludeZoneStocks |
No |
Boolean |
Whether to return the AZ information. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| InstanceSpecSet |
Array of InstanceSpec |
Specification information |
| 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 Query the Instance Specifications Available for Purchase on the Query Purchase Page
This API (DescribeInstanceSpecs) is used to query the instance specifications available for purchase on the query purchase page.
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceSpecs
<Common request parameters>
{
"DbType": "MYSQL"
}
Output Example
{
"Response": {
"InstanceSpecSet": [
{
"Cpu": 1,
"Memory": 1,
"MaxStorageSize": 1,
"MinStorageSize": 1,
"HasStock": true,
"MachineType": "exclusive",
"MaxIops": 0,
"MaxIoBandWidth": 0,
"ZoneStockInfos": [
{
"Zone": "ap-beijing-3",
"HasStock": true,
"StockCount": 0
}
],
"StockCount": 0
}
],
"RequestId": "1c7f08d0-e143-4305-9554-ea236d1a2981"
}
}
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 |
| FailedOperation.DatabaseAccessError |
Failed to access the database. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.OperationFailedError |
Operation failed. Try again later. If the problem persists, contact customer service. |
| InternalError.DbOperationFailed |
Failed to query the database. |
| InternalError.InternalHttpServerError |
An exception occurred while executing the HTTP request. |
| InvalidParameterValue.InvalidParameterValueError |
Invalid parameter value. |
| UnauthorizedOperation.PermissionDenied |
CAM authentication failed. |