tencent cloud

文档反馈

DescribeDCDBPrice

最后更新时间:2024-07-19 14:30:30

    1. API Description

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

    This API is used to query the price of an instance before you purchase it.

    A maximum of 20 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: DescribeDCDBPrice.
    Version Yes String Common Params. The value used for this API: 2018-04-11.
    Region No String Common Params. This parameter is not required for this API.
    Zone Yes String AZ ID of the purchased instance.
    Count Yes Integer The number of instances to be purchased. You can purchase 1-10 instances.
    Period Yes Integer Validity period in months
    ShardNodeCount Yes Integer Number of nodes in a single shard, which can be obtained
    by querying the instance specification through the DescribeDBInstanceSpecs API.
    ShardMemory Yes Integer Shard memory size in GB, which can be obtained
    by querying the instance specification through the DescribeDBInstanceSpecs API.
    ShardStorage Yes Integer Shard storage size in GB, which can be obtained
    by querying the instance specification through the DescribeDBInstanceSpecs API.
    ShardCount Yes Integer The number of shards in the instance. Value range: 2-8. Upgrade your instance to have up to 64 shards if you require more.
    Paymode No String Billing type. Valid values: postpaid (pay-as-you-go), prepaid (monthly subscription).
    AmountUnit No String Price unit. Valid values:
    * pent (cent),
    * microPent (microcent).

    3. Output Parameters

    Parameter Name Type Description
    OriginalPrice Integer Original price
    * Unit: Cent (default). If the request parameter contains AmountUnit, see AmountUnit description.
    * Currency: CNY (Chinese site), USD (international site)
    Price Integer The actual price may be different from the original price due to discounts.
    * Unit: Cent (default). If the request parameter contains AmountUnit, see AmountUnit description.
    * Currency: CNY (Chinese site), USD (international site)
    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 the purchase price of an TDSQL instance (The price returned in the example is for reference only)

    Input Example

    POST / HTTP/1.1
    Host: dcdb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDCDBPrice
    <Common request parameters>
    
    {
        "Count": 1,
        "Zone": "ap-guangzhou-2",
        "ShardNodeCount": "3",
        "Period": "1",
        "ShardMemory": "2",
        "ShardCount": "2",
        "ShardStorage": "10"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "7e1000c2-190a-d0df-ff75-59fbdf5ff381",
            "OriginalPrice": 42240,
            "Price": 42240
        }
    }
    

    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
    InternalError.CamAuthFailed CAM authentication request failed.
    InternalError.QueryPriceFailed Failed to query the price
    InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
    InvalidParameter.SpecNotFound No purchasable specifications found
    InvalidParameterValue.SpecIdIllegal The specification information of the database instance was not found.
    UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.