You need to enable JavaScript to run this app.
导航
容器服务
  • 文档首页
    • /容器服务/API 参考/节点管理/ListNodes
ListNodes
最近更新时间：2024.09.29 18:50:57首次发布时间：2022.06.27 21:21:47
我的收藏

查询符合条件的节点列表及信息。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=ListNodes&Version=2022-05-12

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 公共参数。

参数类型是否必选示例值描述
ActionString是ListNodes接口名称。当前 API 的名称为 ListNodes。
VersionString是2022-05-12接口版本。当前 API 的版本为 2022-05-12。
FilterObject of ListNodesFilter否-待查询节点的筛选条件。
PageNumberInteger否1分页查询时的起始页码，从 1 开始，默认为 1。

PageSize

Integer

否

10

分页查询时每页显示的记录数，取值：

  • 最小值：1
  • 最大值：100
  • 默认值：10

ListNodesFilter

参数类型是否必选示例值描述

ClusterIds

Array of String

否

["cc5silumrsfeq****"]

集群 ID 列表。
可以调用 ListClusters 接口，获取集群 ID。单次最多填写 100 个集群 ID。

说明

此参数为空数组时，筛选基于账号下指定地域的所有集群。

Ids

Array of String

否

["nc5t5epmrsf****"]

节点 ID 列表。
单次调用最多填写 100 个节点 ID。

Name

String

否

test-node

节点名称。
支持模糊匹配。

NodePoolIds

Array of String

否

["pc8oah9cbcv****"]

节点池 ID 列表。
可以调用 ListNodePools 接口，获取节点池 ID。单次调用最多填写 100 个节点池 ID。

ZoneIdsArray of String否["cn-beijing-a"]可用区 ID 列表。容器服务的可用区列表，请参见 地域和可用区。

Statuses

Array of NodeStatusFilter

否

-

节点状态。
单次调用最多填写 15 个数组元素。传入多个状态时，状态间是逻辑「或」关系。

CreateClientToken

String

否

BC028527-33B9-4990-A633-84E9F9******

创建成功时的 ClientToken。
用于保证请求幂等性的字符串。该字符串由调用方传入，需保证不同请求之间唯一。ClientToken 对大小写敏感，且最大值不超过 64 个 ASCII 字符。

NodeStatusFilter

参数类型是否必选示例值描述

Phase

String

否

Running

节点的状态，取值：

  • Creating
  • Running
  • Deleting
  • Failed
  • Updating

注意

Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。

Conditions.Type

String

否

Ok

节点池当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，取值：

  • Progressing
  • Ok
  • Unschedulable
  • InitilizeFailed
  • NotReady
  • Balance
  • ResourceCleanupFailed
  • Unknown

注意

Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。

请求示例

POST https://open.volcengineapi.com/?Action=ListNodes&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "ClusterIds": [
            "cc5silumrsfeq****"
        ],
        "NodePoolIds": [
            "pc8oah9cbcv****"
        ],
        "Statuses": [
            {
                "Phase": "Running",
                "Conditions.Type": "Ok"
            }
        ]
    }
}

返回参数

本接口返回参数如下表所示，公共返回参数请参见 返回结果。

参数类型示例值描述
ItemsArray of Node-节点列表。
PageNumberInteger1当前页码。
PageSizeInteger10每页显示的节点数。
TotalCountInteger100符合条件的节点总数。

Node

参数类型示例值描述
IdStringnc5t5ep********节点 ID。
NameStringtest-node节点名称。
ClusterIdStringcc5silum********集群 ID。
InstanceIdStringi-ybo922********节点对应的云服务器实例 ID。
NodePoolIdStringpc8oah9********节点池 ID。
ZoneIdStringcn-bei******可用区 ID。

Roles

Array of String

["Worker"]

节点角色，参数值说明：
Worker：Worker节点

CreateClientToken

String

BC028527-33B9-4990-A633-84E9F9******

创建成功时的 ClientToken。
ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

CreateTime

String

2021-10-27T10:33:30Z

创建时间。
标准 RFC3339 格式的 UTC+0 时间。

UpdateTime

String

2021-10-29T10:33:30Z

更新时间。
标准 RFC3339 格式的 UTC+0 时间。

StatusObject of NodeStatus-节点状态。

IsVirtual

Boolean

false

是否为虚拟节点，参数值说明：

  • false：否
  • true：是

AdditionalContainerStorageEnabled

Boolean

false

是否已配置节点的数据盘作为容器镜像和日志的存储目录，参数值说明：

  • false：未配置
  • true：已配置
ContainerStoragePathString/dev/vdb用于作为容器镜像和日志存储目录的数据盘设备名称。
ImageIdStringimage-k********节点对应的云服务器实例使用的镜像 ID。
InitializeScriptStringZWNobyAid****创建 ECS 节点并完成 Kubernetes 组件部署后执行的脚本。

KubernetesConfig

Object of KubernetesConfigResponse

-

节点初始化时使用的 Kubernetes 相关配置。

说明

其中，创建节点后添加的 Label（标签）、Taints（污点）不会通过该 OpenAPI 返回，您需要 连接集群 后使用 Kubernetes API 获取。Kubernetes API 相关信息，请参见 官方文档。

NodeStatus

参数类型示例值描述

Phase

String

Running

节点的状态，参数值有：

  • Creating
  • Running
  • Deleting
  • Failed
  • Updating

说明

合法的 Phase 和 Conditions.Type 组合说明，请参见 资源状态说明。

Conditions

Array of NodeStatusCondition

-

节点当前主状态下的状态条件，即进入该主状态的原因。

说明

合法的 Phase 和 Conditions.Type 组合说明，请参见 资源状态说明。

NodeStatusCondition

参数类型示例值描述

Type

String

Ok

节点当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有：

  • Progressing
  • Ok
  • Unschedulable
  • InitilizeFailed
  • NotReady
  • Balance
  • ResourceCleanupFailed
  • Unknown

KubernetesConfigResponse

参数类型示例值描述
LabelsArray of Label-节点池/节点的 Kubernetes 标签（Labels）信息。
TaintsArray of Taint-节点池/节点的 Kubernetes 污点（Taints）信息。

Cordon

Boolean

false

封锁节点配置，参数值说明：

  • false：不封锁。
  • true：封锁。

Label

参数类型示例值描述
KeyStringlabel-key标签键。
ValueStringlabel-value标签值。

Taint

参数类型示例值描述

Effect

String

NoSchedule

污点效果，参数值说明：

  • NoSchedule：不调度。
  • NoExecute：驱逐没有容忍污点的 Pod。
  • PreferNoSchedule：尽量避免调度。
KeyStringtaint-key污点键。
ValueStringtaint-value污点值。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "0216353********",
        "Action": "ListNodes",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "nc5t5ep********",
                "Name": "test-node",
                "ClusterId": "cc5silum********",
                "NodePoolId": "pc8oah9********",
                "Roles": ["Worker"],
                "IsVirtual": false,
                "InstanceId": "i-ybo922********",
                "ZoneId": "cn-bei******",
                "AdditionalContainerStorageEnabled": false,
                "ContainerStoragePath": "",
                "ImageId": "image-kd********",
                "Status": {
                    "Phase": "Running",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "CreateClientToken": "BC028527-33B9-4990-A633-84E9F9******",
                "CreateTime": "2022-05-12T14:28:34Z",
                "UpdateTime": "2022-05-13T14:30:14Z"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

本接口无专有错误码，公共错误码请参见 公共错误码。