You need to enable JavaScript to run this app.
导航
ListVirtualNodes
最近更新时间:2024.06.21 16:12:58首次发布时间:2023.10.26 16:05:10

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

说明

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

请求说明

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

请求参数

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

参数名称类型是否必选示例值说明
ActionStringListVirtualNodes公共参数,本接口值:ListVirtualNodes。
VersionString2022-05-12公共参数,本接口值:2022-05-12。
FilterObject VirtualNodesFilter-待查询虚拟节点的筛选条件。
PageNumberInteger1分页查询时的起始页码,从 1 开始,默认为 1。

PageSize

Integer

10

分页查询时每页显示的记录数,取值:

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

VirtualNodesFilter

参数名称类型是否必选示例值说明

Ids

Array of String

["vck4gdidlemc3o******"]

虚拟节点 ID 列表。
单次最多填写 10 个虚拟节点 ID。

Name

String

"virtualnode"

虚拟节点名称,支持模糊匹配。

说明

此参数为空时,返回指定地域内所有的虚拟节点信息。

Statuses

Array of VirtualNodeStatusFilterRequest

-

虚拟节点的状态。
单次最多填写 15 个数组元素。传入多个状态时,状态间是逻辑 关系。

VirtualNodeStatusFilterRequest

说明

合法的 PhaseConditions.Type 组合说明,请参见本文下方 虚拟节点状态说明

参数名称类型是否必选示例值说明

Phase

String

Creating

虚拟节点的状态,取值:

  • Creating
  • Running
  • Deleting
  • Failed

Conditions.Type

String

Progressing

虚拟节点当前主状态下的状态条件,即进入该主状态的原因,可以有多个原因,取值:

  • Progressing
  • Ok
  • Unavailable
  • CreateFailed

虚拟节点状态说明

PhaseConditions.Type控制台状态映射说明
CreatingProgressing创建中虚拟节点创建中。
RunningOk运行中虚拟节点正常运行中。
DeletingProgressing删除中虚拟节点删除中。
FailedUnavailable异常虚拟节点因网络失联、运行异常等原因导致无法正常工作。
CreateFailed创建失败虚拟节点因各种原因导致无法创建成功。

请求示例

POST /?Action=ListVirtualNodes&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "Filter": {
        "Ids": ["vck4gdidlemc3ou******"]
    },
    "PageNumber": 1,
    "PageSize": 10
}

返回参数

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

参数名参数类型示例值说明
ItemsArray of VirtualNode-虚拟节点列表。
PageNumberInteger1当前页码。
PageSizeInteger10每页显示的虚拟节点数。
TotalCountInteger100返回数据列表的总量。

VirtualNode

参数名参数类型示例值说明
IdStringvck4gdidlemc3ou******虚拟节点 ID。
CreateClientTokenStringBC028527-33B9-4990-A633-84E9F9******创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
NameStringvirtualnode-1虚拟节点的名称。
VirtualNodeConfigObject VirtualNodeConfigResponse-虚拟节点的节点配置信息。
KubernetesConfigObject VirtualNodeKubernetesConfigResponse-虚拟节点的 Kubernetes 配置信息。
StatusObject VirtualNodeStatus-虚拟节点的状态。

CreateTime

String

2021-10-27T10:33:30Z

虚拟节点的创建时间。
标准 RFC3339 格式的 UTC+0 时间。

VirtualNodeConfigResponse

参数名参数类型示例值说明
VpcIdStringvpc-3reuafbrw1qm85zsk2i******虚拟节点网络所在的私有网络(VPC)ID。
SubnetIdsArray of String["subnet-3rfcnoazj4cu85zsk2j******"]虚拟节点网络所属的子网 ID 列表。
SecurityGroupIdsArray of String["sg-3reuafhozdwjk5zsk2i******"]虚拟节点网络所在的安全组 ID 列表。

VirtualNodeKubernetesConfigResponse

参数名参数类型示例值说明
LabelsArray of Label-虚拟节点的 Kubernetes 标签(Labels)信息。
TaintsArray of Taint-虚拟节点的 Kubernetes 污点(Taints)信息。

VirtualNodeStatus

说明

合法的 PhaseConditions.Type 组合说明,请参见本文上方 虚拟节点状态说明

参数名参数类型示例值说明

Phase

String

Creating

虚拟节点的状态,参数值说明:

  • Creating
  • Running
  • Deleting
  • Failed
ConditionsArray of VirtualNodeCondition-虚拟节点当前主状态下的状态条件,即进入该主状态的原因。

VirtualNodeCondition

参数名参数类型示例值说明

Type

String

Progressing

虚拟节点当前主状态下的状态条件,即进入该主状态的原因,可以有多个原因,参数值说明:

  • Progressing
  • Ok
  • Unavailable
  • CreateFailed

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "0216353308101******",
        "Action": "ListVirtualNodes",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10,
        "Items": [
            {
                "Id": "vck4gdidlemc3ou******",
                "Name": "demo-6",
                "VirtualNodeConfig": {
                    "VpcId": "vpc-3reuafbrw1qm85zsk2i******",
                    "SubnetIds": [
                        "subnet-3rfcnoazj4cu85zsk2j******"
                    ],
                    "SecurityGroupIds": [
                        "sg-3reuafhozdwjk5zsk2i******"
                    ]
                },
                "KubernetesConfig": {
                    "Labels": [
                        {
                            "Key": "xx/aaaaa",
                            "Value": "v1"
                        }
                    ],
                    "Taints": [
                        {
                            "Key": "t1",
                            "Value": "tv1",
                            "Effect": "NoSchedule"
                        }
                    ]
                },
                "Status": {
                    "Phase": "Running",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "CreateTime": "2023-09-19T02:26:17Z"
            }
        ]
    }
}

错误码

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