tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeInstanceSpecs

Last updated: 2023-08-23 14:23:02

1. API Description

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

This API is used to query instance specifications.

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.

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: 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.
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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the specification information of a purchasable instance.

    This example shows you how to query the specification information of a purchasable instance.

    Input Example

    POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceSpecs
<Common request parameters>

{
    "DbType": "MYSQL"
}

    Output Example

    {
    "Response": {
        "InstanceSpecSet": [
            {
                "MaxStorageSize": 1,
                "ZoneStockInfos": [
                    {
                        "HasStock": true,
                        "StockCount": 0,
                        "Zone": "ap-guangzhou-3"
                    }
                ],
                "MachineType": "common",
                "StockCount": 0,
                "HasStock": true,
                "Memory": 1,
                "MinStorageSize": 1,
                "MaxIoBandWidth": 0,
                "Cpu": 1,
                "MaxIops": 0
            },
            {
                "MaxStorageSize": 1,
                "ZoneStockInfos": [
                    {
                        "HasStock": true,
                        "StockCount": 0,
                        "Zone": "ap-guangzhou-3"
                    }
                ],
                "MachineType": "common",
                "StockCount": 0,
                "HasStock": true,
                "Memory": 1,
                "MinStorageSize": 1,
                "MaxIoBandWidth": 0,
                "Cpu": 1,
                "MaxIops": 0
            }
        ],
        "RequestId": "test-requestid"
    }
}

    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.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy