tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

InquiryPriceCreateInstance

Last updated: 2024-12-04 11:19:14

    1. API Description

    Domain name for API request: redis.intl.tencentcloudapi.com.

    This API is used to query the price of new instances.

    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: InquiryPriceCreateInstance.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    TypeId Yes Integer Instance type.
    - 2: Redis 2.8 Memory Edition (standard architecture).
    - 6: Redis 4.0 Memory Edition (standard architecture).
    - 7: Redis 4.0 Memory Edition (cluster architecture).
    - 8: Redis 5.0 Memory Edition (standard architecture).
    - 9: Redis 5.0 Memory Edition (cluster architecture).
    - 15: Redis 6.2 Memory Edition (standard architecture).
    - 16: Redis 6.2 Memory Edition (cluster architecture).
    - 17: Redis 7.0 Memory Edition (standard architecture).
    - 18: Redis 7.0 Memory Edition (cluster architecture).
    MemSize Yes Integer Memory capacity in MB, which must be a multiple of 1,024. It is subject to the purchasable specifications returned by the DescribeProductInfo API.
    If TypeId indicates the standard architecture, MemSize indicates the total memory capacity of an instance; if TypeId indicates the cluster architecture, MemSize indicates the memory capacity per shard.
    GoodsNum Yes Integer Number of instances. The actual quantity purchasable at a time is subject to the specifications returned by the DescribeProductInfo API.
    Period Yes Integer Length of purchase in months, which is required when creating a monthly-subscribed instance. Value range: [1,2,3,4,5,6,7,8,9,10,11,12,24,36]. For pay-as-you-go instances, set the parameter to 1.
    BillingMode Yes Integer Billing mode.
    - 0: pay-as-you-go.
    - 1: monthly subscription.
    ZoneId No Integer ID of the AZ where the instance resides. For more information, see Regions and AZs.
    RedisShardNum No Integer Number of instance shards. For the standard architecture of 2.8, the number of shards does not need to be configured. For the standard architecture of other versions, the number of shards should be set to 1. For the cluster architecture, the number of shards to be purchased needs to be specified.
    RedisReplicasNum No Integer Number of instance replicas. For the standard architecture of 2.8, the number of replicas does not need to be configured.
    ReplicasReadonly No Boolean Whether replica read-only is supported. For the standard architecture of Redis 2.8 and CKV, this parameter does not need to be configured.
    - true: Replica read-only is not required.
    - false: Replica read-only is required.
    ZoneName No String Name of the AZ where the instance resides. For more information, see Regions and AZs.
    ProductVersion No String Deployment mode.
    - local: local disk. This is the default value.
    - cloud: cloud disk.
    - cdc: CDC.

    3. Output Parameters

    Parameter Name Type Description
    Price Float Price. Unit: USD (accurate down to the cent)
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Sample

    Input Example

    https://redis.intl.tencentcloudapi.com/?Action=InquiryPriceCreateInstance
&ZoneId=100002
&TypeId=6
&MemSize=4096
&GoodsNum=1
&Period=1
&BillingMode=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Price": 30400,
        "RequestId": "0115d979-2c38-4ad2-b282-bec09d5b4c0b"
    }
}

    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.SystemError Internal system error, which is irrelevant to the business.
    InternalError.InternalError Internal error.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    InvalidParameterValue.SpecNotExist The instance specification doesn’t exist.
    UnauthorizedOperation.NoCAMAuthed No CAM permissions.
    UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy