最近更新时间:2024.03.28 21:41:39
首次发布时间:2022.06.27 21:21:47
查询符合条件的节点列表及信息。
调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。
参数名称 | 类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
Action | String | 是 | ListNodes | 公共参数,本接口值:ListNodes。 |
Version | String | 是 | 2022-05-12 | 公共参数,本接口值:2022-05-12。 |
Filter | Object NodesFilterRequest | 否 | - | 待查询节点的筛选条件。 |
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 Object NodeStatusFilterRequest | 否 | - | 节点状态。 |
CreateClientToken | String | 否 | BC028527-33B9-4990-A633-84E9F9****** | 创建成功时的 ClientToken。 |
注意
Phase 和 Conditions.Type 两者至少有一个参数必填,否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见 资源状态说明。
参数名 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
Phase | String | 否 | Running | 节点的状态,取值:
|
Conditions.Type | String | 否 | Ok | 节点池当前主状态下的状态条件,即进入该主状态的原因,可以有多个原因,取值:
|
POST /?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 | nc5t5epmrsf**** | 节点 ID。 |
Name | String | test-node | 节点名称。 |
ClusterId | String | cc5silumrsfeq**** | 集群 ID。 |
InstanceId | String | i-ybo9229pdf**** | 节点对应的云服务器实例 ID。 |
NodePoolId | String | pc8oah9cbcv**** | 节点池 ID。 |
ZoneId | String | cn-beijing-a | 可用区 ID。 |
Roles | Array Of String | ["Worker"] | 节点角色,参数值说明: |
CreateClientToken | String | BC028527-33B9-4990-A633-84E9F9****** | 创建成功时的 ClientToken。 |
CreateTime | String | 2021-10-27T10:33:30Z | 创建时间。 标准 RFC3339 格式的 UTC+0 时间。 |
UpdateTime | String | 2021-10-29T10:33:30Z | 更新时间。 标准 RFC3339 格式的 UTC+0 时间。 |
Status | Object NodeStatus | 节点状态。 | |
IsVirtual | Boolean | false | 是否为虚拟节点,参数值说明:
|
AdditionalContainerStorageEnabled | Boolean | false | 是否已配置节点的数据盘作为容器镜像和日志的存储目录,参数值说明:
|
ContainerStoragePath | String | /dev/vdb | 用于作为容器镜像和日志存储目录的数据盘设备名称。 |
ImageId | String | image-kdvapv**** | 节点对应的云服务器实例使用的镜像 ID。 |
InitializeScript | String | ZWNo****dGVzdCI= | 创建 ECS 节点并完成 Kubernetes 组件部署后执行的脚本。 |
KubernetesConfig | Object KubernetesConfigResponse | - | 节点初始化时使用的 Kubernetes 相关配置。 |
说明
合法的 Phase 和 Conditions.Type 组合说明,请参见 资源状态说明。
参数名 | 参数类型 | 示例值 | 说明 |
---|---|---|---|
Phase | String | Running | 节点的状态,参数值有:
|
Conditions | Array of NodeCondition | - | 节点当前主状态下的状态条件,即进入该主状态的原因。 |
参数名 | 参数类型 | 示例值 | 说明 |
---|---|---|---|
Type | String | Ok | 节点当前主状态下的状态条件,即进入该主状态的原因,可以有多个原因,参数值有:
|
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "021635330810134****", "Action": "ListNodes", "Version": "2022-05-12", "Service": "vke", "Region": "cn-beijing" }, "Result": { "Items": [ { "Id": "nc5t5epmrsf****", "Name": "test-node", "ClusterId": "cc5silumrsfeq****", "NodePoolId": "pc8oah9cbcv****", "Roles": ["Worker"], "IsVirtual": false, "InstanceId": "i-ybo9229pdf****", "ZoneId": "cn-beijing-a", "AdditionalContainerStorageEnabled": false, "ContainerStoragePath": "", "ImageId": "image-kdvapv****", "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 } }
本接口无专有错误码,公共错误码请参见 公共错误码。