云搜索服务
云搜索服务
文档指南
请输入
- 文档首页
云搜索服务API 参考实例查询DescribeNodeAvailableSpecs - 查询节点可用配置列表
复制全文
下载 pdfDescribeNodeAvailableSpecs - 查询节点可用配置列表
文档反馈
问问助手调用 DescribeNodeAvailableSpecs 接口，查询可用的节点类型、节点规格和存储规格列表，并会返回计费配置码。
请求说明
- 请求方式：POST
- 请求地址：/?Action=DescribeNodeAvailableSpecs&Version=2023-01-01 HTTP/1.1
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeNodeAvailableSpecs
要执行的操作，取值：DescribeNodeAvailableSpecs。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
InstanceId string 可选 示例值：o-00k****718
需要查询的实例 ID。
返回参数
NetworkSpecs object[] 示例值：--
可用的网络配置列表。
SpecName string 示例值：es.eip.bgp_fixed_bandwidth
网络规格名称。
NetworkRole string 示例值：Elasticsearch
网络配置对象。
- Elasticsearch：实例
- Kibana：可视化工具
ConfigurationCode string 示例值：es.standard
计费配置码。
NodeAvailableSpecs object[] 示例值：--
可用的节点列表，按节点类型分类展示信息。
ResourceSpecNames string[] 示例值：[ "es.x4.small", "es.x2.medium", "es.x4.medium", "es.x8.medium", "es.x2.large", "es.x4.large", "es.x8.large", "es.x2.xlarge", "es.x4.xlarge", "es.x8.xlarge", "es.x1.2xlarge", "es.x2.2xlarge", "es.x4.2xlarge", "es.x8.2xlarge", "es.x2.2.5xlarge", "es.x4.2.5xlarge", "es.x8.2.5xlarge", "es.x2.3xlarge" ]
StorageSpecNames string[] 示例值：["es.volume.essd.pl0"]
存储规格名称。
- es.volume.essd.pl0：表示标准版-高性能云盘-pl0。
- es.volume.essd.flexpl-standard：标准版-高性能云盘-flexpl。
- 如需了解更多，请参见产品规格。
Type string 示例值：Master
节点类型，支持的节点类型如下：
- Master：Master 节点。
- Kibana：Kibana 节点。
- Hot：数据节点。
- Coordinator：协调节点。
- Cold：冷数据节点。
- Warm：温数据节点。
ResourceSpecs object[] 示例值：--
可用的节点规格列表。
Description string 示例值：标准版-2C4G节点
节点规格的描述信息。
DisplayName string 示例值：2核4GiB
节点规格的显示名称。
Memory integer 示例值：4
节点规格的内存容量，单位 GiB。
Name string 示例值：es.x2.medium
节点规格。
CPU integer 示例值：2
节点规格的 CPU 资源，单位为核（Core）。
StorageSpecs object[] 示例值：--
可用的存储规格列表。
Description string 示例值：标准版-高性能云盘-pl0
存储规格的描述信息。
DisplayName string 示例值：ESSD-PL0
存储规格的显示名称。
MaxSize integer 示例值：10000
存储规格的最大值，单位为 GiB。
MinSize integer 示例值：20
存储规格最小值，单位为 GiB。
Name string 示例值：es.volume.essd.pl0
存储规格，当前支持的规格如下：
- es.volume.essd.pl0：标准版-高性能云盘-pl0。
- es.volume.essd.flexpl-standard：标准版-高性能云盘-flexpl。
- 如需了解更多，请参见产品规格。
Size integer 示例值：100
配置的可用磁盘空间大小。
AZAvailableSpecsSoldOut object 示例值：{"cn-beijing-b": "1"}
当前地域中可用的可用区列表。
请求示例
POST /?Action=DescribeNodeAvailableSpecs&Version=2023-01-01 HTTP/1.1
Host: escloud.cn-beijing.volcengineapi.com
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
"InstanceId": "o-00k04h**"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20241018170702107103028105038944",
"Action": "DescribeNodeAvailableSpecs",
"Version": "2023-01-01",
"Service": "ESCloud",
"Region": "cn-beijing"
},
"Result": {
"NetworkSpecs": [
{
"SpecName": "es.eip.bgp_fixed_bandwidth",
"NetworkRole": "Elasticsearch"
}
],
"ConfigurationCode": "es.standard",
"NodeAvailableSpecs": [
{
"ResourceSpecNames": [
"[\n\"es.x4.small\",\n\"es.x2.medium\",\n\"es.x4.medium\",\n\"es.x8.medium\",\n\"es.x2.large\",\n\"es.x4.large\",\n\"es.x8.large\",\n\"es.x2.xlarge\",\n\"es.x4.xlarge\",\n\"es.x8.xlarge\",\n\"es.x1.2xlarge\",\n\"es.x2.2xlarge\",\n\"es.x4.2xlarge\",\n\"es.x8.2xlarge\",\n\"es.x2.2.5xlarge\",\n\"es.x4.2.5xlarge\",\n\"es.x8.2.5xlarge\",\n\"es.x2.3xlarge\"\n]"
],
"StorageSpecNames": [
"[\"es.volume.essd.pl0\"]"
],
"Type": "Master"
}
],
"ResourceSpecs": [
{
"Description": "标准版-2C4G节点",
"DisplayName": "2核4GiB",
"Memory": 4,
"Name": "es.x2.medium",
"CPU": 2
}
],
"StorageSpecs": [
{
"Description": "标准版-高性能云盘-pl0",
"DisplayName": "ESSD-PL0",
"MaxSize": 10000,
"MinSize": 20,
"Name": "es.volume.essd.pl0",
"Size": 100
}
],
"AZAvailableSpecsSoldOut": {}
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
200 | IllegalParameter | illegal parameter | 参数非法。原因可能是参数缺失或不符合接口要求。 |
200 | Unauthorized | unauthorized error | 用户无权限调用接口。 |
200 | InternalServerError | 服务器内部异常 | 服务由于异常退出，无法完成接口请求操作。 |
最近更新时间：2026.03.20 15:37:56
这个页面对您有帮助吗？
有用
有用
无用
无用