You need to enable JavaScript to run this app.
导航
DescribeInstanceNodes - 查询实例节点列表
最近更新时间:2025.04.01 16:57:34首次发布时间:2023.11.30 14:19:26
我的收藏
有用
有用
无用
无用

调用 DescribeInstanceNodes 接口,查询实例的成员节点详情,包括节点类型、运行状态、资源配置等信息

请求说明

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

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DescribeInstanceNodes

要执行的操作,取值:DescribeInstanceNodes。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

o-0080**iu98

需要查询节点信息的实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Nodes
Array of Object

--

实例节点列表,以及节点类型、运行状态、资源配置等信息。

请求示例

POST https://open.volcengineapi.com/?Action=DescribeInstanceNodes&Version=2023-01-01
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-0080**iu98"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250331144137085065189199CED66A",
    "Action": "DescribeInstanceNodes",
    "Version": "2023-01-01",
    "Service": "ESCloud",
    "Region": "cn-beijing"
  },
  "Result": {
    "Nodes": [
      {
        "IsHot": true,
        "IsCold": true,
        "Status": "`Running`",
        "IsKibana": true,
        "IsMaster": true,
        "IsWarm": true,
        "NodeName": "`es-coordinator-00k***718-0`",
        "StartTime": "2024-04-01 18:09:16",
        "InstanceId": "o-00k04han***",
        "StorageSpec": {
          "MaxSize": 0,
          "MinSize": 0,
          "Description": "`标准版-高性能云盘-pl0`",
          "DisplayName": "`ESSD-PL0`",
          "Type": "`ESSD-PL0`"
        },
        "ResourceSpec": {
          "CPU": 0,
          "Memory": 0,
          "Description": "`标准版-2C4G节点`",
          "DisplayName": "`2核4GiB`"
        },
        "IsCoordinator": true,
        "RestartNumber": 0,
        "NodeDisplayName": "`es-master-0`"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
InternalServerError

服务器内部异常

服务由于异常退出,无法完成接口请求操作

200
IllegalParameter

illegal parameter

非法参数。可能是参数缺失,也可能是参数不符合接口要求

200
Unauthorized

unauthorized error

用户无权限调用接口