查询符合条件的节点列表及信息。
调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListNodes | 接口名称。当前 API 的名称为 ListNodes 。 |
Version | String | 是 | 2022-05-12 | 接口版本。当前 API 的版本为 2022-05-12 。 |
Filter | Object of ListNodesFilter | 否 | - | 待查询节点的筛选条件。 |
PageNumber | Integer | 否 | 1 | 分页查询时的起始页码,从 1 开始,默认为 1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页显示的记录数,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ClusterIds | Array of String | 否 | ["cc5silumrsfeq****"] | 集群 ID 列表。 说明 此参数为空数组时,筛选基于账号下指定地域的所有集群。 |
Ids | Array of String | 否 | ["nc5t5epmrsf****"] | 节点 ID 列表。 |
Name | String | 否 | test-node | 节点名称。 |
NodePoolIds | Array of String | 否 | ["pc8oah9cbcv****"] | 节点池 ID 列表。 |
ZoneIds | Array of String | 否 | ["cn-beijing-a"] | 可用区 ID 列表。容器服务的可用区列表,请参见 地域和可用区。 |
Statuses | Array of NodeStatusFilter | 否 | - | 节点状态。 |
CreateClientToken | String | 否 | BC028527-33B9-4990-A633-84E9F9****** | 创建成功时的 ClientToken。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Phase | String | 否 | Running | 节点的状态,取值:
注意 Phase 和 Conditions.Type 两者至少有一个参数必填,否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。 |
Conditions.Type | String | 否 | Ok | 节点池当前主状态下的状态条件,即进入该主状态的原因,可以有多个原因,取值:
注意 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" } ] } }
本接口返回参数如下表所示,公共返回参数请参见 返回结果。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items | Array of Node | - | 节点列表。 |
PageNumber | Integer | 1 | 当前页码。 |
PageSize | Integer | 10 | 每页显示的节点数。 |
TotalCount | Integer | 100 | 符合条件的节点总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | nc5t5ep******** | 节点 ID。 |
Name | String | test-node | 节点名称。 |
ClusterId | String | cc5silum******** | 集群 ID。 |
InstanceId | String | i-ybo922******** | 节点对应的云服务器实例 ID。 |
NodePoolId | String | pc8oah9******** | 节点池 ID。 |
ZoneId | String | cn-bei****** | 可用区 ID。 |
Roles | Array of String | ["Worker"] | 节点角色,参数值说明: |
CreateClientToken | String | BC028527-33B9-4990-A633-84E9F9****** | 创建成功时的 ClientToken。 |
CreateTime | String | 2021-10-27T10:33:30Z | 创建时间。 |
UpdateTime | String | 2021-10-29T10:33:30Z | 更新时间。 |
Status | Object of NodeStatus | - | 节点状态。 |
IsVirtual | Boolean | false | 是否为虚拟节点,参数值说明:
|
AdditionalContainerStorageEnabled | Boolean | false | 是否已配置节点的数据盘作为容器镜像和日志的存储目录,参数值说明:
|
ContainerStoragePath | String | /dev/vdb | 用于作为容器镜像和日志存储目录的数据盘设备名称。 |
ImageId | String | image-k******** | 节点对应的云服务器实例使用的镜像 ID。 |
InitializeScript | String | ZWNobyAid**** | 创建 ECS 节点并完成 Kubernetes 组件部署后执行的脚本。 |
KubernetesConfig | Object of KubernetesConfigResponse | - | 节点初始化时使用的 Kubernetes 相关配置。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Phase | String | Running | 节点的状态,参数值有:
说明 合法的 Phase 和 Conditions.Type 组合说明,请参见 资源状态说明。 |
Conditions | Array of NodeStatusCondition | - | 节点当前主状态下的状态条件,即进入该主状态的原因。 说明 合法的 Phase 和 Conditions.Type 组合说明,请参见 资源状态说明。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | Ok | 节点当前主状态下的状态条件,即进入该主状态的原因,可以有多个原因,参数值有:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Labels | Array of Label | - | 节点池/节点的 Kubernetes 标签(Labels)信息。 |
Taints | Array of Taint | - | 节点池/节点的 Kubernetes 污点(Taints)信息。 |
Cordon | Boolean | false | 封锁节点配置,参数值说明:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | label-key | 标签键。 |
Value | String | label-value | 标签值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Effect | String | NoSchedule | 污点效果,参数值说明:
|
Key | String | taint-key | 污点键。 |
Value | String | taint-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 } }
本接口无专有错误码,公共错误码请参见 公共错误码。