You need to enable JavaScript to run this app.
导航
云搜索服务
  • 文档首页
    • /
  • 云搜索服务

DescribeNodeAvailableSpecs - 查询节点可用配置列表

最近更新时间：2024.04.09 15:14:58

首次发布时间：2023.11.30 14:19:28

我的收藏

调用 DescribeNodeAvailableSpecs 接口，查询可用的节点类型、节点规格和存储规格列表，并会返回计费配置码。

请求说明

  • 请求方式：POST
  • 请求地址：/?Action=DescribeNodeAvailableSpecs&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数类型是否必选示例值描述
ActionString是DescribeNodeAvailableSpecs接口名称。当前 API 的名称为 DescribeNodeAvailableSpecs。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
InstanceIdString是o-00k****718需要查询的实例 ID。

返回参数

参数类型示例值描述
ConfigurationCodeStringes.standard计费配置码。
NodeAvailableSpecsArray of NodeAvailableSpecs可用的节点列表，按节点类型分类展示信息。
ResourceSpecsArray of ResourceSpecs可用的节点规格列表。
StorageSpecsArray of StorageSpecs可用的存储规格列表。
AZAvailableSpecsSoldOutObject of AZAvailableSpecsSoldOut{"cn-beijing-b": "1"}当前地域中可用的可用区列表。

NodeAvailableSpecs

参数类型示例值描述

ResourceSpecNames

Array of 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"
]

节点规格名称。不同规格的 CPU 和内存不同，如需了解更多，请参见产品规格。

StorageSpecNames

Array of 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

参数类型示例值描述
DescriptionString标准版-2C4G节点节点规格的描述信息。
DisplayNameString2核4GiB节点规格的显示名称。
MemoryInteger4节点规格的内存容量，单位 GiB。
NameStringes.x2.medium节点规格。
CPUInteger2节点规格的 CPU 资源，单位为核（Core）。

StorageSpecs

参数类型示例值描述
DescriptionString标准版-高性能云盘-pl0存储规格的描述信息。
DisplayNameStringESSD-PL0存储规格的显示名称。
MaxSizeInteger10000存储规格的最大值，单位为 GiB。
MinSizeInteger20存储规格最小值，单位为 GiB。

Name

String

es.volume.essd.pl0

存储规格，当前支持的规格如下：

  • es.volume.essd.pl0：标准版-高性能云盘-pl0。
  • es.volume.essd.flexpl-standard：标准版-高性能云盘-flexpl。
SizeInteger100配置的可用磁盘空间大小。

请求示例

POST https://open.volcengineapi.com/?Action=DescribeNodeAvailableSpecs&Version=2023-01-01 HTTP/1.1
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": "20240403104717D63BE80C9F2***",
        "Action": "DescribeNodeAvailableSpecs",
        "Version": "2023-01-01",
        "Service": "escloud",
        "Region": "cn-beijing"
    },
    "Result": {
        "ConfigurationCode": "es.standard",
        "NodeAvailableSpecs": [
            {
                "ResourceSpecNames": [
                    "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": [
                    "es.volume.essd.pl0"
                ],
                "Type": "Master"
            },
            {
                "ResourceSpecNames": [
                    "kibana.x2.small",
                    "kibana.x2.medium",
                    "kibana.x4.medium",
                    "kibana.x2.large",
                    "kibana.x4.large",
                    "kibana.x2.xlarge",
                    "kibana.x4.xlarge",
                    "kibana.x2.2xlarge",
                    "kibana.x4.2xlarge",
                    "kibana.x2.3xlarge",
                    "kibana.x4.3xlarge"
                ],
                "Type": "Kibana"
            },
            {
                "ResourceSpecNames": [
                    "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",
                    "es.x4.3xlarge"
                ],
                "StorageSpecNames": [
                    "es.volume.essd.pl0",
                    "es.volume.essd.flexpl-standard"
                ],
                "Type": "Hot"
            },
            {
                "ResourceSpecNames": [
                    "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": [
                    "es.volume.essd.pl0"
                ],
                "Type": "Coordinator"
            },
            {
                "ResourceSpecNames": [
                    "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",
                    "es.x4.3xlarge"
                ],
                "StorageSpecNames": [
                    "es.volume.essd.pl0"
                ],
                "Type": "Warm"
            }
        ],
        "ResourceSpecs": [
            {
                "Description": "Kibana专用-1C2G节点",
                "DisplayName": "1核2GiB",
                "Memory": 2,
                "Name": "kibana.x2.small",
                "CPU": 1
            },
            {
                "Description": "标准版-1C4G节点",
                "DisplayName": "1核4GiB",
                "Memory": 4,
                "Name": "es.x4.small",
                "CPU": 1
            },
            {
                "Description": "标准版-2C4G节点",
                "DisplayName": "2核4GiB",
                "Memory": 4,
                "Name": "es.x2.medium",
                "CPU": 2
            },
            {
                "Description": "标准版-kibana-2C4G节点",
                "DisplayName": "2核4GiB",
                "Memory": 4,
                "Name": "kibana.x2.medium",
                "CPU": 2
            },
            {
                "Description": "标准版-2C8G节点",
                "DisplayName": "2核8GiB",
                "Memory": 8,
                "Name": "es.x4.medium",
                "CPU": 2
            },
            {
                "Description": "标准版-kibana-2C8G节点",
                "DisplayName": "2核8GiB",
                "Memory": 8,
                "Name": "kibana.x4.medium",
                "CPU": 2
            },
            {
                "Description": "标准版-2C16G节点",
                "DisplayName": "2核16GiB",
                "Memory": 16,
                "Name": "es.x8.medium",
                "CPU": 2
            },
            {
                "Description": "标准版-4C8G节点",
                "DisplayName": "4核8GiB",
                "Memory": 8,
                "Name": "es.x2.large",
                "CPU": 4
            },
            {
                "Description": "标准版-kibana-4C8G节点",
                "DisplayName": "4核8GiB",
                "Memory": 8,
                "Name": "kibana.x2.large",
                "CPU": 4
            },
            {
                "Description": "标准版-4C16G节点",
                "DisplayName": "4核16GiB",
                "Memory": 16,
                "Name": "es.x4.large",
                "CPU": 4
            },
            {
                "Description": "标准版-kibana-4C16G节点",
                "DisplayName": "4核16GiB",
                "Memory": 16,
                "Name": "kibana.x4.large",
                "CPU": 4
            },
            {
                "Description": "标准版-4C32G节点",
                "DisplayName": "4核32GiB",
                "Memory": 32,
                "Name": "es.x8.large",
                "CPU": 4
            },
            {
                "Description": "标准版-8C16G节点",
                "DisplayName": "8核16GiB",
                "Memory": 16,
                "Name": "es.x2.xlarge",
                "CPU": 8
            },
            {
                "Description": "标准版-kibana-8C16G节点",
                "DisplayName": "8核16GiB",
                "Memory": 16,
                "Name": "kibana.x2.xlarge",
                "CPU": 8
            },
            {
                "Description": "标准版-8C32G节点",
                "DisplayName": "8核32GiB",
                "Memory": 32,
                "Name": "es.x4.xlarge",
                "CPU": 8
            },
            {
                "Description": "标准版-kibana-8C32G节点",
                "DisplayName": "8核32GiB",
                "Memory": 32,
                "Name": "kibana.x4.xlarge",
                "CPU": 8
            },
            {
                "Description": "标准版-8C64G节点",
                "DisplayName": "8核64GiB",
                "Memory": 64,
                "Name": "es.x8.xlarge",
                "CPU": 8
            },
            {
                "Description": "标准版-16C16G节点",
                "DisplayName": "16核16GiB",
                "Memory": 16,
                "Name": "es.x1.2xlarge",
                "CPU": 16
            },
            {
                "Description": "标准版-16C32G节点",
                "DisplayName": "16核32GiB",
                "Memory": 32,
                "Name": "es.x2.2xlarge",
                "CPU": 16
            },
            {
                "Description": "标准版-kibana-16C32G节点",
                "DisplayName": "16核32GiB",
                "Memory": 32,
                "Name": "kibana.x2.2xlarge",
                "CPU": 16
            },
            {
                "Description": "标准版-16C64G节点",
                "DisplayName": "16核64GiB",
                "Memory": 64,
                "Name": "es.x4.2xlarge",
                "CPU": 16
            },
            {
                "Description": "标准版-kibana-16C64G节点",
                "DisplayName": "16核64GiB",
                "Memory": 64,
                "Name": "kibana.x4.2xlarge",
                "CPU": 16
            },
            {
                "Description": "标准版-16C128G节点",
                "DisplayName": "16核128GiB",
                "Memory": 128,
                "Name": "es.x8.2xlarge",
                "CPU": 16
            },
            {
                "Description": "标准版-24C48G节点",
                "DisplayName": "24核48GiB",
                "Memory": 48,
                "Name": "es.x2.2.5xlarge",
                "CPU": 24
            },
            {
                "Description": "标准版-24C96G节点",
                "DisplayName": "24核96GiB",
                "Memory": 96,
                "Name": "es.x4.2.5xlarge",
                "CPU": 24
            },
            {
                "Description": "标准版-24C192G节点",
                "DisplayName": "24核192GiB",
                "Memory": 192,
                "Name": "es.x8.2.5xlarge",
                "CPU": 24
            },
            {
                "Description": "标准版-32C64G节点",
                "DisplayName": "32核64GiB",
                "Memory": 64,
                "Name": "es.x2.3xlarge",
                "CPU": 32
            },
            {
                "Description": "标准版-kibana-32C64G节点",
                "DisplayName": "32核64GiB",
                "Memory": 64,
                "Name": "kibana.x2.3xlarge",
                "CPU": 32
            },
            {
                "Description": "标准版-32C128G节点",
                "DisplayName": "32核128GiB",
                "Memory": 128,
                "Name": "es.x4.3xlarge",
                "CPU": 32
            },
            {
                "Description": "标准版-kibana-32C128G节点",
                "DisplayName": "32核128GiB",
                "Memory": 128,
                "Name": "kibana.x4.3xlarge",
                "CPU": 32
            }
        ],
        "StorageSpecs": [
            {
                "Description": "标准版-高性能云盘-pl0",
                "DisplayName": "ESSD-PL0",
                "MaxSize": 10000,
                "MinSize": 20,
                "Name": "es.volume.essd.pl0",
                "Size": 0,
                "Type": ""
            },
            {
                "Description": "标准版-高性能云盘-flexpl",
                "DisplayName": "ESSD-FlexPL",
                "MaxSize": 10000,
                "MinSize": 20,
                "Name": "es.volume.essd.flexpl-standard",
                "Size": 0,
                "Type": ""
            }
        ],
        "AZAvailableSpecsSoldOut": {
            "cn-guangzhou-a": "1",
            "cn-guangzhou-b": "1"
        }
    }
}