ListNodePools--容器服务-火山引擎

文档中心

立即注册

导航

ListNodePools

最近更新时间：2024.09.29 18:50:56首次发布时间：2022.06.27 21:21:42

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	ListNodePools	接口名称。当前 API 的名称为 `ListNodePools`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Filter	Object of ListNodePoolsFilter	否	-	待查询节点池的筛选条件。
Tags	Array of ListTagFilter	否	-	基于标签查询节点池列表。 Tags 中各个 Key 不可重复。 Tags 中的 Key、Value 不允许在最前或最后输入空格。单次最多支持 10 个标签。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

ListNodePoolsFilter

参数	类型	是否必选	示例值	描述
ClusterIds	Array of String	否	["cc5silumrsfeq****"]	集群 ID。可以调用 ListClusters 接口，获取集群 ID。单次最多填写 100 个集群 ID。说明此参数为空数组时，基于账号下指定地域的所有集群进行筛选。
Ids	Array of String	否	["pc51i0m6rsfen****"]	节点池 ID 列表。单次最多填写 100 个节点池 ID。
Name	String	否	test-nodepool	节点池名称。支持模糊匹配。说明此参数为空时，返回指定集群内所有的节点池信息。
AutoScaling.Enabled	Boolean	否	true	节点池弹性伸缩配置信息，取值： true：开启弹性伸缩。 false：关闭弹性伸缩。
Statuses	Array of NodePoolStatusFilter	否	-	节点池状态。单次最多填写 15 个数组元素。传入多个状态时，状态间是逻辑或关系。
CreateClientToken	String	否	ed6b1190-dc17-11ec-9519-eb58a7******	创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
UpdateClientToken	String	否	ed6b1190-dc17-11ec-9519-eb58a7******	最后一次更新成功时 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

NodePoolStatusFilter

参数	类型	是否必选	示例值	描述
Phase	String	否	Running	节点池的状态，取值： Creating Running Updating Deleting Failed Scaling 注意 Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见资源状态说明。
Conditions.Type	String	否	Ok	节点池当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，取值： Progressing Ok ResourceCleanupFailed Unknown ClusterNotRunning 注意 Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见资源状态说明。

参数

类型

是否必选

示例值

描述

Phase

String

否

Running

节点池的状态，取值：

Creating
Running
Updating
Deleting
Failed
Scaling

注意

Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见资源状态说明。

Conditions.Type

String

否

节点池当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，取值：

Progressing
Ok
ResourceCleanupFailed
Unknown
ClusterNotRunning

注意

Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见资源状态说明。

ListTagFilter

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Key	String	是	key	标签键。不能以任何大小写形式的`volc:`开头。只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。长度限制为 1～128 个字符。
Value	String	否	value	标签值，可以为空。只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。长度不超过 256 个字符。

Key

String

是

key

标签键。

不能以任何大小写形式的volc:开头。
只能包含语言字符、数字、空格和特殊符号_.:/=+-@。
长度限制为 1～128 个字符。

Value

String

否

value

标签值，可以为空。

只能包含语言字符、数字、空格和特殊符号_.:/=+-@。
长度不超过 256 个字符。

请求示例

POST https://open.volcengineapi.com/?Action=ListNodePools&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "ClusterIds": [
            "cc5silumrsfeq****"
        ],
        "Statuses": [
            {
                "Phase": "Running",
                "Conditions.Type": "Ok"
            }
        ]
    },
     "Tags": [
        {
            "Key": "key",
            "Value": "value"
        }
    ]
}

返回参数

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

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

NodePool

参数	类型	示例值	描述
Id	String	pc51i0m6********	节点池 ID。
CreateClientToken	String	BC028527-33B9-4990-A633-84E9F9******	创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
UpdateClientToken	String	BC028527-33B9-4990-A633-84E9F9******	最后一次更新成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
ClusterId	String	cc5silum********	集群 ID。
Name	String	test-nodepool	节点池名称。
KubernetesConfig	Object of NodePoolKubernetesConfigResponse	-	节点池 Kubernetes 配置。
NodeConfig	Object of NodePoolNodeConfigResponse	-	节点池中云服务器实例配置。
AutoScaling	Object of NodePoolAutoScalingResponse	-	节点池伸缩策略配置。
CreateTime	String	2021-10-27T10:33:30Z	创建节点池的时间。标准 RFC3339 格式的 UTC+0 时间。
UpdateTime	String	2021-10-29T10:33:30Z	更新节点池的时间。标准 RFC3339 格式的 UTC+0 时间。
Status	Object of NodePoolStatus	-	节点池状态。
NodeStatistics	Object of NodeStatistics	-	节点池中的节点统计。
Tags	Array of TagResponse	-	节点池绑定的标签信息。

NodePoolKubernetesConfigResponse

参数	类型	示例值	描述
Labels	Array of Label	-	节点池/节点的 Kubernetes 标签（Labels）信息。
Taints	Array of Taint	-	节点池/节点的 Kubernetes 污点（Taints）信息。
Cordon	Boolean	false	封锁节点配置，参数值说明： false：不封锁。 true：封锁。
NamePrefix	String	xxx-	Kubernetes 中节点对象的元数据名称前缀。

Label

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

Taint

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

参数

类型

示例值

描述

Effect

String

NoSchedule

污点效果，参数值说明：

NoSchedule：不调度。
NoExecute：驱逐没有容忍污点的 Pod。
PreferNoSchedule：尽量避免调度。

Key

String

taint-key

污点键。

Value

String

taint-value

污点值。

NodePoolNodeConfigResponse

参数	类型	示例值	描述
InstanceTypeIds	Array of String	["ecs.g1ie.large"]	节点对应的云服务器实例规格 ID 列表。规格详细说明，请参见实例规格清单。
SubnetIds	Array of String	["subnet-3rf6vwbgkg****"]	节点网络所属的子网 ID 列表。
ImageId	String	image-kd********	节点对应云服务器所使用的镜像 ID。
SystemVolume	Object of SystemVolume	-	节点的系统盘配置。
DataVolumes	Array of DataVolume	-	节点的数据盘配置。
InitializeScript	String	ZWNobyAidG******	创建并初始化节点后执行的自定义脚本。 Base64 编码后的 Shell 格式脚本。
Security	Object of NodeSecurityResponse	-	节点安全配置。
AdditionalContainerStorageEnabled	Boolean	false	节点的第一块数据盘是否已配置并格式化挂载作为容器镜像和日志的存储目录，参数值说明： false：未配置并格式化。 true：已配置并格式化。
InstanceChargeType	String	PostPaid	云服务器实例计费类型，参数值说明： PostPaid：按量计费 PrePaid：包年包月
Period	Integer	12	云服务器实例购买时长，单位为月。仅当`InstanceChargeType=PrePaid`时才返回的参数。
AutoRenew	Boolean	true	云服务器实例到期是否自动续费，参数值说明： true：自动续费 false：不自动续费仅当`InstanceChargeType=PrePaid`时才返回的参数。
AutoRenewPeriod	Integer	1	云服务器实例每次自动续费时长，单位为月。仅当`AutoRenew=true`时才返回的参数。
NamePrefix	String	prefix-name	节点名称前缀，为空字符串或 nil 时表示未开启节点名称前缀策略。
HpcClusterIds	Array of String	["hpcCluster-1"]	高性能计算集群 ID。当节点池配置为高性能计算 GPU 型规格节点时，返回高性能计算集群 ID。
Tags	Array of Tag	-	节点对应 ECS 实例绑定的标签信息。

SystemVolume

参数	类型	示例值	描述
Type	String	ESSD_PL0	云盘类型： ESSD_PL0：性能级别为 PL0 的极速型 SSD 云盘。 ESSD_FlexPL：性能级别为 PL1 的极速型 SSD 云盘。
Size	Integer	40	云盘容量，单位 GiB。

参数

类型

示例值

描述

Type

String

ESSD_PL0

云盘类型：

ESSD_PL0：性能级别为 PL0 的极速型 SSD 云盘。
ESSD_FlexPL：性能级别为 PL1 的极速型 SSD 云盘。

Size

Integer

云盘容量，单位 GiB。

DataVolume

参数	类型	示例值	描述
Type	String	ESSD_PL0	磁盘类型： ESSD_PL0：性能级别为 PL0 的极速型 SSD 云盘。 ESSD_FlexPL：性能级别为 PL1 的极速型 SSD 云盘。
Size	Integer	20	磁盘容量，单位 GiB。
MountPoint	String	/vke	磁盘格式化后的目标挂载目录。

参数

类型

示例值

描述

Type

String

ESSD_PL0

磁盘类型：

ESSD_PL0：性能级别为 PL0 的极速型 SSD 云盘。
ESSD_FlexPL：性能级别为 PL1 的极速型 SSD 云盘。

Size

Integer

磁盘容量，单位 GiB。

MountPoint

String

/vke

磁盘格式化后的目标挂载目录。

NodeSecurityResponse

参数	类型	示例值	描述
SecurityGroupIds	Array of String	["sg-2byy13cnsczyxxxx"]	节点网络所在的安全组 ID 列表。
SecurityStrategyEnabled	Boolean	true	节点是否启用了安全加固配置，参数值说明： true：已开启 false：未开启
SecurityStrategies	Array of String	["Hids"]	节点的安全策略，参数值说明： Hids：主机安全加固。
Login	Object of NodeLoginResponse	-	节点的访问方式配置。

NodeLoginResponse

参数	类型	示例值	描述
Type	String	Password	节点的访问登录方式，参数值说明： Password：密码登录。 SshKeyPair：SSH 密钥对登录。
SshKeyPairName	String	test-key	SSH 密钥对名称。

参数

类型

示例值

描述

Type

String

Password

节点的访问登录方式，参数值说明：

Password：密码登录。
SshKeyPair：SSH 密钥对登录。

SshKeyPairName

String

test-key

SSH 密钥对名称。

Tag

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

NodePoolAutoScalingResponse

参数	类型	示例值	描述
Enabled	Boolean	false	配置节点池弹性伸缩功能开关，参数值说明： false：关闭。 true：开启。
MaxReplicas	Integer	10	配置节点池的最大节点数。
MinReplicas	Integer	0	配置节点池的最小节点数。
DesiredReplicas	Integer	0	配置节点池的期望节点数。
Priority	Integer	10	优先级。说明仅针对节点池开启弹性伸缩功能且扩容算法为`priority`时，优先级才会生效。
SubnetPolicy	String	ZoneBalance	节点池的多子网调度策略，参数值说明： ZoneBalance：可用区均衡策略。 Priority：子网优先级策略。

NodePoolStatus

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

参数

类型

示例值

描述

Phase

String

Running

节点池的状态，参数值有：

Creating
Running
Updating
Deleting
Failed
Scaling

说明

合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。

Conditions

Array of NodePoolStatusCondition

节点池当前主状态下的状态条件，即进入该主状态的原因。

NodePoolStatusCondition

参数	类型	示例值	描述
Type	String	Ok	节点池当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有： Progressing Ok ResourceCleanupFailed Unknown ClusterNotRunning

参数

类型

示例值

描述

Type

String

节点池当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有：

Progressing
Ok
ResourceCleanupFailed
Unknown
ClusterNotRunning

NodeStatistics

参数	类型	示例值	描述
TotalCount	Integer	8	节点总数量。
CreatingCount	Integer	1	`Phase=Creating`的节点总数量。
RunningCount	Integer	1	`Phase=Running`的节点总数量。
UpdatingCount	Integer	1	`Phase=Updating`的节点总数量。
DeletingCount	Integer	1	`Phase=Deleting`的节点总数量。
FailedCount	Integer	1	`Phase=Failed`的节点总数量。

TagResponse

参数

类型

示例值

描述

Key

String

key

标签键。

Value

String

value

标签值。

Type

String

Custom

标签类型，参数值说明：

System： 系统标签。
Custom：用户自定义标签。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "0216353********",
        "Action": "ListNodePools",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "pc51i0m6********",
                "Name": "test-nodepool",
                "ClusterId": "cc5silum********",
                "KubernetesConfig": {
                    "Labels": [
                        {
                            "Key": "label-key",
                            "Value": "label-value"
                        }
                    ],
                    "Taints": [
                        {
                            "Key": "taint-key",
                            "Value": "taint-value",
                            "Effect": "NoSchedule"
                        }
                    ],
                    "Cordon": false
                },
                "NodeConfig": {
                    "InstanceTypeIds": [
                        "ecs.g1.large"
                    ],
                    "SubnetIds": [
                        "subnet-3rf6vwbgkg****"
                    ],
                    "ImageId": "image-kd********",
                    "SystemVolume": {
                        "Type": "ESSD_PL0",
                        "Size": 40
                    },
                    "DataVolumes": [
                        {
                            "Type": "ESSD_PL0",
                            "Size": 20
                        }
                    ],
                    "AdditionalContainerStorageEnabled": true,
                    "InitializeScript": "ZWNobyAidG******",
                    "Security": {
                        "SecurityGroupIds": [
                            "sg-2byy13cnsczy****"
                        ],
                        "SecurityStrategyEnabled": true,
                        "SecurityStrategies": [
                            "Hids"
                        ],
                        "Login": {
                            "Type": "Password",
                            "SshKeyPairName": ""
                        }
                    },
                    "InstanceChargeType": "PostPaid",
                    "Period": 0,
                    "AutoRenew": false,
                    "AutoRenewPeriod": 0,
                    "NamePrefix": "name-prefix"
                },
                "AutoScaling": {
                    "Enabled": true,
                    "DesiredReplicas": 1,
                    "MinReplicas": 0,
                    "MaxReplicas": 10,
                    "Priority": 10,
                    "SubnetPolicy": "Priority"
                },
                "Status": {
                    "Phase": "Running",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "NodeStatistics": {
                    "TotalCount": 1,
                    "CreatingCount": 0,
                    "RunningCount": 1,
                    "UpdatingCount": 0,
                    "DeletingCount": 0,
                    "FailedCount": 0
                },
                 "Tags": [
                    {
                        "Key": "key",
                        "Value": "value",
                        "Type": "Custom"
                    }
                ],
                "CreateClientToken": "BB928624-11C0-4856-A233-84F9F9******",
                "UpdateClientToken": "BC028527-33B9-4990-A633-54A859******",
                "CreateTime": "2022-05-11T17:01:23+08:00",
                "UpdateTime": "2022-05-12T17:01:23+08:00"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

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