DescribeProductInfo

Last updated: 2019-09-09 12:20:58

1. API Description

API domain name: redis.tencentcloudapi.com.

This API queries the capacity specifications of Redis instances in the specified availability zone and instance type. If you are not in the whitelist for an availability zone or instance type, you cannot view the capacity specification details of that availability zone or instance type. You can submit a ticket for whitelist application.

Default API request rate limit: 20 requests/sec.

Note: This API supports financial availability zones. Because financial availability zones and non-financial availability zones are isolated, if the common parameter Region specifies a financial availability zone (e.g., ap-shanghai-fsi), you need to specify a domain name with the financial availability zone as well, which preferably in the same region as the specified Region, for example: vod.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: DescribeProductInfo
Version Yes String Common parameter; the version of this API: 2018-04-12
Region Yes String Common parameters; for details, see the List of Regions supported by the product.

3. Output Parameters

Parameter name Type Description
RegionSet Array of RegionConf Region-specific sale information
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Request Example

Input Sample Code

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

Output Sample Code

{
  "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

API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.SystemError Internal system error, irrelevant to the business.
InvalidParameter Parameter error
InvalidParameter.EmptyParam The specified parameter is not allowed to have an empty value.
InvalidParameter.PermissionDenied The API has no CAM permissions.