文档中心

容器服务

请输入

虚拟节点管理

ListVirtualNodes - 查询虚拟节点列表

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

说明

【邀测·申请试用】：虚拟节点相关 OpenAPI 功能目前处于邀测阶段。如果需要使用，请提交申请。

请求说明

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

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

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	ListVirtualNodes	接口名称。当前 API 的名称为 ListVirtualNodes。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
Filter	Object of VirtualNodesFilter	否	-	待查询虚拟节点的筛选条件。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

VirtualNodesFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["v73mhao7vj0g58ozfe53xxxx"]	虚拟节点 ID 列表。单次最多填写 10 个虚拟节点 ID。
Name	String	否	node-1	虚拟节点名称，支持模糊匹配。说明此参数为空时，返回指定地域内所有的虚拟节点信息。
Statuses	Array of VirtualNodeStatusFilterRequest	否	-	虚拟节点的状态。单次最多填写 15 个数组元素。传入多个状态时，状态间是逻辑或关系。

VirtualNodeStatusFilterRequest

参数	类型	是否必选	示例值	描述
Phase	String	否	Running	虚拟节点的状态，取值： Creating Running Deleting Failed 说明合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。
Conditions.Type	String	否	Ok	虚拟节点当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，取值： Progressing Ok Unavailable CreateFailed 说明合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。

请求示例

返回参数

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

VirtualNode

参数	类型	示例值	描述
Id	String	v73mhao7vj********	虚拟节点 ID。
CreateClientToken	String	BC028527-33B9-4990-A633-84E9F9******	创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
Name	String	vci-vnode-cn-beijing-1	虚拟节点的名称。
VirtualNodeConfig	Object of VirtualNodeConfig	-	虚拟节点的节点配置信息。
KubernetesConfig	Object of VirtualNodeKubernetesConfigResponse	-	虚拟节点的 Kubernetes 配置信息。
Status	Object of VirtualNodeStatus	-	虚拟节点的状态。
CreateTime	String	2022-05-06T02:49:19Z	虚拟节点的创建时间。标准 RFC3339 格式的 UTC+0 时间。

VirtualNodeConfig

VirtualNodeKubernetesConfigResponse

参数	类型	示例值	描述
Labels	Array of Label	-	虚拟节点的 Kubernetes 标签（Labels）信息。
Taints	Array of Taint	-	虚拟节点的 Kubernetes 污点（Taints）信息。

Label

Taint

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

VirtualNodeStatus

参数	类型	示例值	描述
Phase	String	Creating	虚拟节点的状态，参数值说明： Creating Running Deleting Failed 说明合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。
Conditions	Array of VirtualNodeStatusCondition	-	虚拟节点当前主状态下的状态条件，即进入该主状态的原因。说明合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。

VirtualNodeStatusCondition

参数	类型	示例值	描述
Type	String	Ok	虚拟节点当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值说明： Progressing Ok Unavailable CreateFailed

返回示例

错误码

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

最近更新时间：2026.01.14 15:53:17

这个页面对您有帮助吗？

有用

无用