查询集群内所有节点池列表。
接口说明
单用户调用频率: 100 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClusterId |
string |
是 |
A short description of struct |
eck-xxxxxxxx |
| PageNumber |
integer |
是 |
分页页码(从 1 开始) |
1 |
| PageSize |
integer |
是 |
分页每页大小 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| Page |
object |
当前页页码。 |
|
| PageNumber |
integer |
页码。 |
1 |
| PageSize |
integer |
输入时设置的每页行数。 |
10 |
| TotalCount |
integer |
总数。 |
20 |
| NodePools |
array<object> |
节点池列表。 |
|
|
array<object> |
|||
| NodepoolInfo |
object |
节点池信息。 |
|
| Name |
string |
节点池名称。 |
eck-node-pool-1 |
| EnsRegionId |
string |
ENS 的节点 ID。 |
cn-fuzhou-23 |
| NodepoolId |
string |
节点池 ID。 |
np68mi5y1dd748ky37ojo2kqdrz |
| ScalingGroup |
object |
弹性伸缩组 |
|
| VswitchIds |
array |
虚拟交换机 id。 |
|
|
string |
虚拟交换机 id。 |
vsw-58eu2p6v64qw8ihhit1wz7wgv |
|
| InstanceChargeType |
string |
实例计费方式。 |
PrePaid |
| InstanceTypes |
array |
规格列表信息。 |
|
|
string |
规格列表信息。 |
ens.sn1.small |
|
| SystemDiskCategory |
string |
节点系统盘类型,可选类型:"local_ssd", "cloud_ssd", "cloud_efficiency", "local_hdd"。 |
cloud_efficiency |
| SystemDiskSize |
integer |
节点系统盘大小 |
80 |
| ImageId |
string |
镜像 ID。 |
m-673f5z4h69ibwtallg6zmcaxr |
| KeyPairName |
string |
密钥对名称。 |
key-pair-name |
| DataDisks |
array<object> |
数据盘列表,参数限制同系统盘 |
|
|
object |
数据盘列表,参数限制同系统盘 |
||
| Category |
string |
磁盘类型 |
cloud_efficiency |
| Size |
integer |
磁盘大小,单位 GB。 |
80 |
| Password |
string |
实例的密码。 |
************ |
| KubernetesConfig |
object |
kubernetes 相关配置。 |
|
| PreUserData |
string |
实例创建后,接入集群前执行的脚本,内容需要 base64。 |
ZWNobyBvawo= |
| UserData |
string |
实例创建后,接入集群后执行的脚本,内容需要 base64。 |
ZWNobyBvawo= |
| Status |
object |
节点池状态。 |
|
| State |
string |
节点池状态。
|
active |
| TotalNodes |
integer |
总实例数(包含创建中、使用中、删除中的)。 |
10 |
| DesiredNodes |
integer |
期望实例数。 |
10 |
| ServingNodes |
integer |
使用中的实例数。 |
10 |
| InitialNodes |
integer |
创建中的实例数。 |
0 |
| RemovingNodes |
integer |
删除中的实例数。 |
0 |
| ClusterId |
string |
集群 ID。 |
eck-xxxxxxxx |
| RequestId |
string |
请求 ID。 |
F3B261DD-3858-4D3C-877D-303ADF374600 |
示例
正常返回示例
JSON格式
{
"Page": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 20
},
"NodePools": [
{
"NodepoolInfo": {
"Name": "eck-node-pool-1",
"EnsRegionId": "cn-fuzhou-23",
"NodepoolId": "np68mi5y1dd748ky37ojo2kqdrz"
},
"ScalingGroup": {
"VswitchIds": [
"vsw-58eu2p6v64qw8ihhit1wz7wgv"
],
"InstanceChargeType": "PrePaid",
"InstanceTypes": [
"ens.sn1.small"
],
"SystemDiskCategory": "cloud_efficiency",
"SystemDiskSize": 80,
"ImageId": "m-673f5z4h69ibwtallg6zmcaxr",
"KeyPairName": "key-pair-name",
"DataDisks": [
{
"Category": "cloud_efficiency",
"Size": 80
}
],
"Password": "************"
},
"KubernetesConfig": {
"PreUserData": "ZWNobyBvawo=",
"UserData": "ZWNobyBvawo="
},
"Status": {
"State": "active",
"TotalNodes": 10,
"DesiredNodes": 10,
"ServingNodes": 10,
"InitialNodes": 0,
"RemovingNodes": 0
},
"ClusterId": "eck-xxxxxxxx"
}
],
"RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | BadRequest | Request param error. | 请求参数错误 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。