You need to enable JavaScript to run this app.
导航
DescribeInstanceNodes - 查询实例节点列表
最近更新时间:2024.04.09 15:04:00首次发布时间:2023.11.30 14:19:26

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

请求说明

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

请求参数

Query

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

Body

参数类型是否必选示例值描述
InstanceIdStringo-0080**iu98需要查询节点信息的实例 ID。

返回参数

参数类型示例值描述
NodesArray of ESNodeInfo实例节点列表,以及节点类型、运行状态、资源配置等信息。

ESNodeInfo

参数类型示例值描述
IsHotBooleantrue节点是否是实例的数据节点。
  • true:是数据节点。
  • false:不是数据节点。
  • IsColdBooleantrue节点是否是实例的冷数据节点。
  • true:是冷数据节点。
  • false:不是冷数据节点。
  • Status

    String

    Running

    节点状态。
    可能返回的状态有:Other(其他)、Running(正常)、Error(失联)、Warn(告警)。

    IsKibanaBooleantrue节点是否是实例的 Kibana 节点。
  • true:是 Kibana 节点。
  • false:不是 Kibana 节点。
  • IsMasterBooleantrue节点是否是实例的 Master 节点。
  • true:是 Master 节点。
  • false:不是 Master 节点。
  • NodeNameStringes-coordinator-00k***718-0节点名称。
    StartTimeString2024-04-01 18:09:16节点上一次启动的时间。
    InstanceIdStringo-00k04han***实例 ID。
    StorageSpecObject of StorageSpec节点的存储配置详情。
    ResourceSpecObject of ResourceSpec节点的规格配置详情。
    IsCoordinatorBooleantrue节点是否是实例的协调节点。
  • true:是协调节点。
  • false:不是协调节点。
  • RestartNumberInteger0节点自创建以来重启过的次数。
    NodeDisplayNameStringes-master-0节点显示名称。

    StorageSpec

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

    ResourceSpec

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

    请求示例

    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": "20240402104330041C92F537E**",
            "Action": "DescribeInstanceNodes",
            "Version": "2023-01-01",
            "Service": "escloud",
            "Region": "cn-guangzhou"
        },
        "Result": {
            "Nodes": [
                {
                    "InstanceId": "o-00k04ha***",
                    "NodeName": "es-master-00k04***-0",
                    "NodeDisplayName": "es-master-0",
                    "Status": "Running",
                    "StartTime": "2024-04-01 18:09:16",
                    "RestartNumber": 0,
                    "IsMaster": true,
                    "IsHot": true,
                    "IsCoordinator": false,
                    "IsWarm": false,
                    "IsCold": false,
                    "IsKibana": false,
                    "HaveLog": true,
                    "ResourceSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "StorageSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "MinSize": 0,
                        "MaxSize": 0,
                        "Type": "ESSD-PL0",
                        "Size": 20
                    }
                },
                {
                    "InstanceId": "o-00k04h***",
                    "NodeName": "es-master-00k04ha***-1",
                    "NodeDisplayName": "es-master-1",
                    "Status": "Running",
                    "StartTime": "2024-04-01 18:09:16",
                    "RestartNumber": 0,
                    "IsMaster": true,
                    "IsHot": true,
                    "IsCoordinator": false,
                    "IsWarm": false,
                    "IsCold": false,
                    "IsKibana": false,
                    "HaveLog": true,
                    "ResourceSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "StorageSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "MinSize": 0,
                        "MaxSize": 0,
                        "Type": "ESSD-PL0",
                        "Size": 20
                    }
                },
                {
                    "InstanceId": "o-00k04ha***",
                    "NodeName": "es-master-00k04han***-2",
                    "NodeDisplayName": "es-master-2",
                    "Status": "Running",
                    "StartTime": "2024-04-01 18:09:16",
                    "RestartNumber": 0,
                    "IsMaster": true,
                    "IsHot": true,
                    "IsCoordinator": false,
                    "IsWarm": false,
                    "IsCold": false,
                    "IsKibana": false,
                    "HaveLog": true,
                    "ResourceSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "StorageSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "MinSize": 0,
                        "MaxSize": 0,
                        "Type": "ESSD-PL0",
                        "Size": 20
                    }
                },
                {
                    "InstanceId": "o-00k04ha***",
                    "NodeName": "kibana-00k04ha***",
                    "NodeDisplayName": "kibana",
                    "Status": "Running",
                    "StartTime": "2024-04-01 18:09:16",
                    "RestartNumber": 0,
                    "IsMaster": false,
                    "IsHot": false,
                    "IsCoordinator": false,
                    "IsWarm": false,
                    "IsCold": false,
                    "IsKibana": true,
                    "HaveLog": true,
                    "ResourceSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "Memory": 2,
                        "CPU": 1
                    },
                    "StorageSpec": {
                        "Description": "",
                        "DisplayName": "",
                        "MinSize": 0,
                        "MaxSize": 0,
                        "Type": "",
                        "Size": 0
                    }
                }
            ]
        }
    }