tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSpec

Last updated: 2024-09-12 11:47:46

1. API Description

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

This API is used to pull the specification list of data nodes and zookeeper nodes for the cluster on the purchase page.

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: DescribeSpec.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
Zone Yes String Region information, such as ap-guangzhou-1.
PayMode No String Billing type. PREPAID: annual/monthly package; POSTPAID_BY_HOUR: pay-as-you-go
Zones.N No Array of String Multi-availability zone
SpecName No String Model name

3. Output Parameters

Parameter Name Type Description
MasterSpec Array of ResourceSpec Zookeeper node specification description
CoreSpec Array of ResourceSpec Data node specification description
AttachCBSSpec Array of DiskSpec Cloud disk list
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 Obtaining the Cluster Specification

This example shows you how to pull the specification list of the cluster's data nodes and zookeeper nodes through the purchase page.

Input Example

https://cdwdoris.tencentcloudapi.com/?Action=DescribeSpec
&Zone=ap-guangzhou-1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "10058bc0-40e7-4eb0-9b4d",
        "MasterSpec": [
            {
                "Name": "SCH3",
                "Cpu": 2,
                "Mem": 4,
                "Type": "STANDARD",
                "DataDisk": {
                    "DiskCount": 1,
                    "MaxDiskSize": 32000,
                    "MinDiskSize": 100,
                    "DiskType": "CLOUD_HSSD",
                    "DiskDesc": "Enhanced SSD"
                },
                "SystemDisk": {
                    "DiskCount": 1,
                    "MaxDiskSize": 50,
                    "MinDiskSize": 50,
                    "DiskType": "CLOUD_PREMIUM",
                    "DiskDesc": "Premium cloud disk"
                },
                "MaxNodeSize": 50,
                "Available": true,
                "ComputeSpecDesc": "2-core; 4 GB"
            }
        ],
        "CoreSpec": [
            {
                "Name": "SCH6",
                "Cpu": 4,
                "Mem": 16,
                "Type": "STANDARD",
                "DataDisk": {
                    "DiskCount": 1,
                    "MaxDiskSize": 32000,
                    "MinDiskSize": 100,
                    "DiskType": "CLOUD_HSSD",
                    "DiskDesc": "Enhanced SSD"
                },
                "SystemDisk": {
                    "DiskCount": 1,
                    "MaxDiskSize": 50,
                    "MinDiskSize": 50,
                    "DiskType": "CLOUD_PREMIUM",
                    "DiskDesc": "Premium cloud disk"
                },
                "MaxNodeSize": 50,
                "Available": true,
                "ComputeSpecDesc": "4-core; 16 GB"
            }
        ],
        "AttachCBSSpec": [
            {
                "DiskCount": 1,
                "MaxDiskSize": 32000,
                "MinDiskSize": 100,
                "DiskType": "CLOUD_HSSD",
                "DiskDesc": "Enhanced SSD"
            }
        ]
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy