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

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=ListNodes&Version=2022-05-12

调试

API Explorer

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

去调试

请求参数

调用该 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	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

ListNodesFilter

参数	类型	是否必选	示例值	描述
ClusterIds	Array of String	否	["cc5silumrsfeqxxxx"]	集群 ID 列表。可以调用 ListClusters 接口，获取集群 ID。单次最多填写 100 个集群 ID。说明此参数为空数组时，筛选基于账号下指定地域的所有集群。
Ids	Array of String	否	["nc5t5epmrsfxxxx"]	节点 ID 列表。单次调用最多填写 100 个节点 ID。
Name	String	否	test-node	节点名称。支持模糊匹配。
NodePoolIds	Array of String	否	["pc8oah9cbcvxxxx"]	节点池 ID 列表。可以调用 ListNodePools 接口，获取节点池 ID。单次调用最多填写 100 个节点池 ID。
ZoneIds	Array of String	否	["cn-beijing-a"]	可用区 ID 列表。容器服务的可用区列表，请参见地域和可用区。
Statuses	Array of NodeStatusFilter	否	-	节点状态。单次调用最多填写 15 个数组元素。传入多个状态时，状态间是逻辑「或」关系。
CreateClientToken	String	否	BusinessRequest12345	创建成功时的 ClientToken。用于保证请求幂等性的字符串。该字符串由调用方传入，需保证不同请求之间唯一。ClientToken 对大小写敏感，且最大值不超过 64 个 ASCII 字符。
InstanceIds	Array of String	否	["i-yd329xxxx"]	节点对应 ECS 实例的 ID。需要精确匹配。可以调用 DescribeInstances - 查询实例列表接口，获取节点对应 ECS 实例 ID。单次调用最多填写 100 个实例 ID。
MetadataName	String	否	192.168.*.*	按节点元数据名称过滤。支持模糊匹配。
AffinityGroupIds	Array of String	否	["agp-xxxx"]	【邀测·申请试用】按亲和组 ID 过滤，精确查询。注意使用节点池亲和组相关功能时，除了获取 VKE 侧功能邀测权限以外，您还需要申请 ECS 侧亲和组相关功能邀测权限。请联系您的火山引擎客户经理咨询。亲和组 ID 请调用 DescribeInstances 接口获取。

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：未知错误 ClusterVersionUpgrading：节点版本升级中说明 Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见资源状态说明。

请求示例

返回参数

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

参数	类型	示例值	描述
Items	Array of Node	-	节点列表。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	每页显示的节点数。
TotalCount	Integer	100	符合条件的节点总数。

Node

参数	类型	示例值	描述
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"]	节点角色，参数值说明： Worker：Worker节点
CreateClientToken	String	BusinessRequest12345	创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
CreateTime	String	2021-10-27T10:33:30Z	创建时间。标准 RFC3339 格式的 UTC+0 时间。
UpdateTime	String	2021-10-29T10:33:30Z	更新时间。标准 RFC3339 格式的 UTC+0 时间。
Status	Object of NodeStatus	-	节点状态。
IsVirtual	Boolean	false	是否为虚拟节点，参数值说明： false：否 true：是
AdditionalContainerStorageEnabled	Boolean	false	是否已配置节点的数据盘作为容器镜像和日志的存储目录，参数值说明： false：未配置 true：已配置
ContainerStoragePath	String	/dev/vdb	用于作为容器镜像和日志存储目录的数据盘设备名称。
ImageId	String	image-kd********	节点对应的云服务器实例使用的镜像 ID。
InitializeScript	String	ZWNob****	创建 ECS 节点并完成 Kubernetes 组件部署后执行的脚本。
KubernetesConfig	Object of KubernetesConfigResponse	-	节点初始化时使用的 Kubernetes 相关配置。说明其中，创建节点后添加的 Label（标签）、Taints（污点）不会通过该 OpenAPI 返回，您需要连接集群后使用 Kubernetes API 获取。Kubernetes API 相关信息，请参见官方文档。
PreScript	String	ZWNob****	【邀测·申请试用】部署节点前执行的脚本 Base64 编码内容。
MetadataName	String	192.168.*.*	Kubernetes 中节点对象的元数据名称。
AffinityGroupId	String	affinityGro********	【邀测·申请试用】节点所属的亲和组 ID。
GpuDriverVersion	String	550.1.1	GPU 驱动版本。
ContainerStorageMountPoint	String	/mnt/vdb	数据盘设备格式化后的目标挂载目录。

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：未知错误 ClusterVersionUpgrading：节点版本升级中

KubernetesConfigResponse

参数	类型	示例值	描述
Labels	Array of Label	-	节点池/节点的 Kubernetes 标签（Labels）信息。
Taints	Array of Taint	-	节点池/节点的 Kubernetes 污点（Taints）信息。
Cordon	Boolean	false	封锁节点配置，参数值说明： false：不封锁 true：封锁

Label

参数	类型	示例值	描述
Key	String	label-key	标签键。
Value	String	label-value	标签值。

Taint

参数	类型	示例值	描述
Key	String	taint-key	污点键。
Value	String	taint-value	污点值。
Effect	String	NoSchedule	污点效果，参数值说明： NoSchedule：不调度。 NoExecute：驱逐没有容忍污点的 Pod。 PreferNoSchedule：尽量避免调度。

返回示例

错误码

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

容器服务