文档中心

ListNodePools

最近更新时间：2024.02.26 20:17:36

首次发布时间：2022.06.27 21:21:42

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

请求参数

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

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

NodePoolsFilter

参数名	参数类型	是否必选	示例值	说明
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 Object NodePoolStatusFilterRequest	否		节点池状态。单次最多填写 15 个数组元素。传入多个状态时，状态间是逻辑或关系。
CreateClientToken	String	否	ed6b1190-dc17-11ec-9519-eb58a7******	创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
UpdateClientToken	String	否	BC028527-33B9-4990-A633-54A859******	最后一次更新成功时 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

NodePoolStatusFilterRequest

注意

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

参数名	参数类型	是否必选	示例值	说明
Phase	String	否	Running	节点池的状态，取值： Creating Running Updating Deleting Failed Scaling
Conditions.Type	String	否	Ok	节点池当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，取值： Progressing Ok ResourceCleanupFailed Unknown ClusterNotRunning

参数名

参数类型

是否必选

示例值

说明

Phase

String

否

Running

节点池的状态，取值：

Creating
Running
Updating
Deleting
Failed
Scaling

Conditions.Type

String

否

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

Progressing
Ok
ResourceCleanupFailed
Unknown
ClusterNotRunning

请求示例

POST /?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		节点池列表。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	每页显示的节点池数。
TotalCount	Integer	100	返回数据列表的总量。

NodePool

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

NodePoolNodeConfigResponse

参数名	参数类型	示例值	说明
InstanceTypeIds	Array of String	["ecs.g1.large"]	节点对应的云服务器实例规格 ID 列表。规格详细说明，请参见实例规格清单。
SubnetIds	Array of String	["subnet-3rf6vwbgkg****"]	节点网络所属的子网 ID 列表。
ImageId	String	image-kdvapv****	节点对应云服务器所使用的镜像 ID。
SystemVolume	Object SystemVolume		节点的系统盘配置。
DataVolumes	Array of DataVolume		节点的数据盘配置。
InitializeScript	String	ZWNobyAidG******	创建并初始化节点后执行的自定义脚本。 Base64 编码后的 Shell 格式脚本。
Security	Object 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	name-prefix	节点名称前缀，为空字符串或 nil 时表示未开启节点名称前缀策略。
HpcClusterIds	Array of String	["hpcCluster-yc2jlqcg7kb5oy******"]	高性能计算集群 ID。当节点池配置为高性能计算 GPU 型规格节点时，返回高性能计算集群 ID。
Tags	Array of Tag		节点对应 ECS 实例绑定的标签信息。

Tag

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

NodeSecurityResponse

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

NodeLoginResponse

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

参数名

参数类型

示例值

说明

Type

String

Password

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

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

SshKeyPairName

String

test-key

SSH 密钥对名称。

NodePoolStatus

说明

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

参数名	参数类型	示例值	说明
Phase	String	Running	节点池的状态，参数值有： Creating Running Updating Deleting Failed Scaling
Conditions	Array of NodePoolCondition		节点池当前主状态下的状态条件，即进入该主状态的原因。

参数名

参数类型

示例值

说明

Phase

String

Running

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

Creating
Running
Updating
Deleting
Failed
Scaling

Conditions

Array of NodePoolCondition

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

NodePoolCondition

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

参数名

参数类型

示例值

说明

Type

String

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

Progressing
Ok
ResourceCleanupFailed
Unknown
ClusterNotRunning

NodePoolAutoScaling

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

SystemVolume

参数名	参数类型	示例值	说明
Type	String	ESSD_PL0	系统盘类型： PTSSD：性能型 SSD 云盘。 ESSD_PL0：性能级别为 PL0 的极速型 SSD 云盘。
Size	Integer	40	系统盘容量，单位 GiB。

参数名

参数类型

示例值

说明

Type

String

ESSD_PL0

系统盘类型：

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

Size

Integer

系统盘容量，单位 GiB。

DataVolume

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

参数名

参数类型

示例值

说明

Type

String

ESSD_PL0

数据盘类型：

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

Size

Integer

数据盘容量，单位 GiB。

MountPoint

String

/vke

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

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "021635330810134****",
        "Action": "ListNodePools",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "pc51i0m6rsfen****",
                "Name": "test-nodepool",
                "ClusterId": "cc5silumrsfeq****",
                "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-kdvapv****",
                    "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
    }
}

错误码

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

请求参数

NodePoolsFilter

NodePoolStatusFilterRequest

请求示例

返回参数

NodePool

NodePoolNodeConfigResponse

Tag

NodeSecurityResponse

NodeLoginResponse

NodePoolStatus

NodePoolCondition

NodePoolAutoScaling

SystemVolume

DataVolume

返回示例

错误码

容器服务

ListNodePools

请求参数

NodePoolsFilter

NodePoolStatusFilterRequest

请求示例

返回参数

NodePool

NodePoolNodeConfigResponse

Tag

NodeSecurityResponse

NodeLoginResponse

NodePoolStatus

NodePoolCondition

NodePoolAutoScaling

SystemVolume

DataVolume

返回示例

错误码