调用 DescribeNodeAvailableSpecs 接口,查询可用的节点类型、节点规格和存储规格列表,并会返回计费配置码。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeNodeAvailableSpecs | 要执行的操作,取值:DescribeNodeAvailableSpecs。 |
Version | String | 是 | 2023-01-01 | API的版本,取值:2023-01-01。 |
InstanceId | String | 否 | o-00k****718 | 需要查询的实例 ID。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
NetworkSpecs | Array of Object | -- | 可用的网络配置列表 |
ConfigurationCode | String | es.standard | 计费配置码。 |
NodeAvailableSpecs | Array of Object | -- | 可用的节点列表,按节点类型分类展示信息。 |
ResourceSpecs | Array of Object | -- | 可用的节点规格列表。 |
StorageSpecs | Array of Object | -- | 可用的存储规格列表。 |
AZAvailableSpecsSoldOut | Object | {"cn-beijing-b": "1"} | 当前地域中可用的可用区列表。 |
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": "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 | 非法参数。可能是参数缺失,也可能是参数不符合接口要求 |
200 | Unauthorized | 用户无权限调用接口 |
200 | InternalServerError | 服务由于异常退出,无法完成接口请求操作 |