1. 接口描述
接口请求域名: cdwdoris.tencentcloudapi.com 。
拉取集群节点规格列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSpec。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Zone | 是 | String | 地域信息,例如"ap-guangzhou-1" 示例值:ap-guangzhou-1 |
PayMode | 否 | String | 计费类型,PREPAID 包年包月,POSTPAID_BY_HOUR 按量计费 示例值:PREPAID |
Zones.N | 否 | Array of String | 多可用区 示例值:["ap-guangzhou-1","ap-guangzhou-2"] |
SpecName | 否 | String | 机型名称 示例值:S_4_16_H |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MasterSpec | Array of ResourceSpec | fe节点规格描述 示例值:[ { "Available": true, "ComputeSpecDesc": "4核16G", "Cpu": 4, "InstanceQuota": 583, "MaxNodeSize": 50, "Mem": 16, "Name": "S_4_16_H", "Type": "STANDARD" } ] |
CoreSpec | Array of ResourceSpec | be节点规格描述 示例值:[ { "Available": true, "ComputeSpecDesc": "4核16G", "Cpu": 4, "InstanceQuota": 583, "MaxNodeSize": 50, "Mem": 16, "Name": "S_4_16_H", "Type": "STANDARD" } ] |
AttachCBSSpec | Array of DiskSpec | 云盘列表 示例值:[ { "DiskCount": 1, "DiskDesc": "增强型SSD云硬盘", "DiskType": "CLOUD_HSSD", "MaxDiskSize": 32000, "MinDiskSize": 1000 }] |
CNSpec | Array of ResourceSpec | cn节点列表 示例值:[ { "Available": true, "ComputeSpecDesc": "4核16G", "Cpu": 4, "InstanceQuota": 583, "MaxNodeSize": 50, "Mem": 16, "Name": "S_4_16_H", "Type": "STANDARD" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取集群规格
购买页拉取集群节点规格列表
输入示例
https://cdwdoris.tencentcloudapi.com/?Action=DescribeSpec
&Zone=ap-guangzhou-1
&<公共请求参数>
输出示例
{
"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": "增强型SSD云硬盘"
},
"SystemDisk": {
"DiskCount": 1,
"MaxDiskSize": 50,
"MinDiskSize": 50,
"DiskType": "CLOUD_PREMIUM",
"DiskDesc": "高性能云硬盘"
},
"MaxNodeSize": 50,
"Available": true,
"ComputeSpecDesc": "2核4G"
}
],
"CoreSpec": [
{
"Name": "SCH6",
"Cpu": 4,
"Mem": 16,
"Type": "STANDARD",
"DataDisk": {
"DiskCount": 1,
"MaxDiskSize": 32000,
"MinDiskSize": 100,
"DiskType": "CLOUD_HSSD",
"DiskDesc": "增强型SSD云硬盘"
},
"SystemDisk": {
"DiskCount": 1,
"MaxDiskSize": 50,
"MinDiskSize": 50,
"DiskType": "CLOUD_PREMIUM",
"DiskDesc": "高性能云硬盘"
},
"MaxNodeSize": 50,
"Available": true,
"ComputeSpecDesc": "4核16G"
}
],
"AttachCBSSpec": [
{
"DiskCount": 1,
"MaxDiskSize": 32000,
"MinDiskSize": 100,
"DiskType": "CLOUD_HSSD",
"DiskDesc": "增强型SSD云硬盘"
}
]
}
}
示例2 获取特定机型规格
获取特定机型规格
输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpec
<公共请求参数>
{
"Zone": "ap-chongqing-1",
"SpecName": "S_4_16_H"
}
输出示例
{
"Response": {
"AttachCBSSpec": [
{
"DiskCount": 1,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 32000,
"MinDiskSize": 1000
},
{
"DiskCount": 1,
"DiskDesc": "SSD云硬盘",
"DiskType": "CLOUD_SSD",
"MaxDiskSize": 32000,
"MinDiskSize": 1000
},
{
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 32000,
"MinDiskSize": 1000
}
],
"CNSpec": [
{
"Available": true,
"ComputeSpecDesc": "4核16G",
"Cpu": 4,
"DataDisk": {
"DiskCount": 10,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"InstanceQuota": 583,
"MaxNodeSize": 50,
"Mem": 16,
"Name": "S_4_16_H",
"SystemDisk": {
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 50,
"MinDiskSize": 50
},
"Type": "STANDARD"
}
],
"CoreSpec": [
{
"Available": true,
"ComputeSpecDesc": "4核16G",
"Cpu": 4,
"DataDisk": {
"DiskCount": 10,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"InstanceQuota": 583,
"MaxNodeSize": 50,
"Mem": 16,
"Name": "S_4_16_H",
"SystemDisk": {
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 50,
"MinDiskSize": 50
},
"Type": "STANDARD"
}
],
"MasterSpec": [
{
"Available": true,
"ComputeSpecDesc": "4核16G",
"Cpu": 4,
"DataDisk": {
"DiskCount": 10,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"InstanceQuota": 583,
"MaxNodeSize": 50,
"Mem": 16,
"Name": "S_4_16_H",
"SystemDisk": {
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 50,
"MinDiskSize": 50
},
"Type": "STANDARD"
}
],
"RequestId": "d654c06b-173e-49d7-b368-c74aad9472f0"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。