DescribeProductInfo

Last updated: 2019-12-05 18:55:34

PDF

1. API Description

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

This API is used to query the purchasable capacity specifications of Redis instances in the specified AZ and instance type. If you are not in the whitelist for the AZ or instance type, you cannot view the details of the capacity specifications. To apply for the eligibility, please submit a ticket.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeProductInfo
Version Yes String Common parameter. The value used for this API: 2018-04-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
RegionSet Array of RegionConf Sale information of a region
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Request Sample

Input Example

https://redis.tencentcloudapi.com/?Action=DescribeProductInfo
&<Common request parameter>

Output Example

{
  "Response": {
    "RegionSet": [
      {
        "RegionId": "ap-guangzhou",
        "RegionName": "Guangzhou",
        "RegionShortName": "GZ",
        "Area": "South China",
        "ZoneSet": [
          {
            "ZoneId": "ap-guangzhou-2",
            "ZoneName": "Guangzhou Zone 2",
            "IsSaleout": false,
            "IsDefault": false,
            "NetWorkType": [
              "basenet",
              "vpcnet"
            ],
            "ProductSet": [
              {
                "Type": 7,
                "TypeName": "Redis cluster edition",
                "MinBuyNum": 1,
                "MaxBuyNum": 10,
                "Saleout": false,
                "Engine": "Redis community edition",
                "Version": "Redis 4.0",
                "TotalSize": [
                  "12",
                  "20",
                  "32",
                  "64",
                  "96",
                  "128",
                  "256",
                  "384",
                  "512",
                  "768",
                  "1024",
                  "2048",
                  "3072",
                  "4096"
                ],
                "ShardSize": [
                  "4",
                  "8",
                  "12",
                  "16",
                  "20",
                  "24",
                  "32"
                ],
                "ReplicaNum": [
                  "1",
                  "2",
                  "3",
                  "4",
                  "5"
                ],
                "ShardNum": [
                  "3",
                  "5",
                  "8",
                  "12",
                  "16",
                  "24",
                  "32",
                  "40",
                  "48",
                  "64",
                  "80",
                  "96",
                  "128"
                ],
                "PayMode": "1",
                "EnableRepicaReadOnly": true
              },
              {
                "Type": 4,
                "TypeName": "CKV cluster edition",
                "MinBuyNum": 1,
                "MaxBuyNum": 10,
                "Saleout": false,
                "Engine": "Tencent Cloud CKV",
                "Version": "Redis 3.2",
                "TotalSize": [
                  "12",
                  "20",
                  "32",
                  "64",
                  "96",
                  "128",
                  "256",
                  "384",
                  "512",
                  "768",
                  "1024",
                  "2048",
                  "3072",
                  "4096"
                ],
                "ShardSize": [
                  "4",
                  "8",
                  "16",
                  "24",
                  "32",
                  "48",
                  "64",
                  "80",
                  "96",
                  "128",
                  "160",
                  "192",
                  "256",
                  "320",
                  "384"
                ],
                "ReplicaNum": [
                  "1",
                  "2",
                  "3",
                  "4",
                  "5"
                ],
                "ShardNum": [
                  "3",
                  "5",
                  "8",
                  "12",
                  "16",
                  "24",
                  "32",
                  "40",
                  "48",
                  "64",
                  "80",
                  "96",
                  "128"
                ],
                "PayMode": "1",
                "EnableRepicaReadOnly": false
              },
              {
                "Type": 2,
                "TypeName": "Redis master/slave edition",
                "MinBuyNum": 1,
                "MaxBuyNum": 10,
                "Saleout": false,
                "Engine": "Redis community edition",
                "Version": "Redis 2.8",
                "TotalSize": [
                  "1",
                  "2",
                  "4",
                  "8",
                  "12",
                  "16",
                  "20",
                  "24",
                  "32",
                  "40",
                  "48",
                  "60",
                  "0.25"
                ],
                "ShardSize": [
                  "1",
                  "2",
                  "4",
                  "8",
                  "12",
                  "16",
                  "20",
                  "24",
                  "32",
                  "40",
                  "48",
                  "60",
                  "0.25"
                ],
                "ReplicaNum": [
                  "1"
                ],
                "ShardNum": [
                  "1"
                ],
                "PayMode": "1",
                "EnableRepicaReadOnly": false
              },
              {
                "Type": 5,
                "TypeName": "Redis standalone edition",
                "MinBuyNum": 1,
                "MaxBuyNum": 10,
                "Saleout": false,
                "Engine": "Redis community edition",
                "Version": "Redis 2.8",
                "TotalSize": [
                  "1",
                  "2",
                  "4",
                  "8",
                  "12",
                  "16",
                  "20",
                  "24",
                  "32",
                  "40",
                  "48",
                  "60"
                ],
                "ShardSize": [
                  "1",
                  "2",
                  "4",
                  "8",
                  "12",
                  "16",
                  "20",
                  "24",
                  "32",
                  "40",
                  "48",
                  "60"
                ],
                "ReplicaNum": [
                  "0"
                ],
                "ShardNum": [
                  "1"
                ],
                "PayMode": "1",
                "EnableRepicaReadOnly": false
              },
              {
                "Type": 2,
                "TypeName": "Redis master-slave edition",
                "MinBuyNum": 1,
                "MaxBuyNum": 10,
                "Saleout": false,
                "Engine": "Redis community edition",
                "Version": "Redis 2.8",
                "TotalSize": [
                  "1",
                  "2",
                  "4",
                  "8",
                  "12",
                  "16",
                  "20",
                  "24",
                  "32",
                  "40",
                  "48",
                  "60"
                ],
                "ShardSize": [
                  "1",
                  "2",
                  "4",
                  "8",
                  "12",
                  "16",
                  "20",
                  "24",
                  "32",
                  "40",
                  "48",
                  "60"
                ],
                "ReplicaNum": [
                  "1"
                ],
                "ShardNum": [
                  "1"
                ],
                "PayMode": "0",
                "EnableRepicaReadOnly": false
              },
              {
                "Type": 3,
                "TypeName": "CKV standalone edition",
                "MinBuyNum": 1,
                "MaxBuyNum": 10,
                "Saleout": false,
                "Engine": "Tencent Cloud CKV",
                "Version": "Redis 3.2",
                "TotalSize": [
                  "4",
                  "8",
                  "16",
                  "24",
                  "32",
                  "48",
                  "64",
                  "80",
                  "96",
                  "128",
                  "160",
                  "192",
                  "256",
                  "320",
                  "384"
                ],
                "ShardSize": [
                  "4",
                  "8",
                  "16",
                  "24",
                  "32",
                  "48",
                  "64",
                  "80",
                  "96",
                  "128",
                  "160",
                  "192",
                  "256",
                  "320",
                  "384"
                ],
                "ReplicaNum": [
                  "0"
                ],
                "ShardNum": [
                  "1"
                ],
                "PayMode": "1",
                "EnableRepicaReadOnly": false
              }
            ]
          }
        ]
      }
    ],
    "RequestId": "3c5730c6-02f2-46fd-8bf1-725b8b608fb9"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.
InvalidParameter Invalid parameter.
InvalidParameter.EmptyParam The parameter is empty.
InvalidParameter.PermissionDenied The API has no CAM permissions.