全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询集群节点列表

接口说明

分页查询集群节点列表,纳管集群节点列表不会分页,查询的是全量。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:DescribeClusterInstance。
Version String
公共参数,本接口取值:2019-08-06。
ClusterId String

集群id

MaxResults Int

单次调用所返回的最大实例数目,默认10,最大50。

Marker Int

分页标识,单次调用未返回全部实例时,标记下次调用的返回值的起点,默认值是0。

Filter.N Object
Name String

支持的过滤器参数

  • instance-name 实例名称
  • instance-role 实例角色
  • instance-id 实例id
  • instance-ip 实例ip
  • instance-status 实例状态
  • node-pool-id 节点所属节点池id
示例值:instance-name
Value.N String
Search String

模糊匹配,可以匹配如下字段:
主网卡私有IP(PrivateIpAddress)。

返回参数

参数名称
类型
描述
InstanceSet Object[]
InstanceId String

节点实例id

示例值:6f2faec7-057f-455f-a45c-xxxxxx
InstanceName String

实例名称

示例值:openapi-worker-1
InstanceRole String

节点角色

  • Worker
  • Master
  • Etcd
  • Master_Etcd
示例值:Worker
InstanceStatus String

节点实例状态

  • building 创建中
  • failed 失败
  • normal 正常
  • abnormal 异常
  • installing 安装中
  • deleting 删除中
  • rebuilding 重装中
示例值:normal
KecInstancePara Object

虚拟机节点配置信息

ProjectId Int

实例所属项目ID

示例值:0
InstanceType String

节点套餐

示例值:I3.4B
InstanceConfigure Object

节点的配置信息

VCPU Int

cpu核数

示例值:4
MemoryGb Int

内存大小

示例值:8
GPU Int

gpu卡数

示例值:0
DataDiskGb Int

本地数据盘大小

示例值:50
RootDiskGb Int

系统盘大小

示例值:20
DataDiskType String

数据盘类型(SSD3.0、EHDD)

示例值:SSD3.0
SystemDisk Object

系统盘信息

DiskType String

系统盘类型

  • Local_SSD
  • SSD3.0
  • EHDD
  • ESSD_PL0
  • ESSD_PL1
  • ESSD_PL2
示例值:Local_SSD
DiskSize Int

系统盘大小

示例值:20
ImageId String

镜像id

示例值:5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7
PrivateIpAddress String

主网卡私有ip地址

示例值:10.0.22.28
ChargeType String

实例的计费方式

示例值:Daily
CreateTime String

实例创建时间

示例值:2019-09-10T15:22:43Z
AvailabilityZone String

节点所在可用区

示例值:cn-beijing-6b
SubnetId String

主网卡所在的子网id

示例值:7e23b980-11c2-4bb0-9388-xxxxxx
VpcId String

主网卡所在vpcid

示例值:31e21dca-c92e-4b06-a8ce-xxxxxx
NetworkInterfaceSet Object[]

网卡信息

NetworkInterfaceId String

网卡id

示例值:9b80391e-a720-40de-95d2-xxxxxx
NetworkInterfaceType String

网卡的类型

示例值:primary
SubnetId String

子网id

示例值:7e23b980-11c2-4bb0-9388-xxxxxx
PrivateIpAddress String

服务器的网卡在vpc中的IP

示例值:10.0.22.28
MacAddress String

云服务器MAC

示例值:fa:16:3e:0e:0a:f8
SecurityGroupSet Object[]

安全组信息

SecurityGroupId String
示例值:d46c7672-7ca9-4f51-bbd9-xxxxxx
DedicatedName String

专属宿主机的名称

DedicatedId String

专属宿主机的id

UnSchedulable Boolean

是否可调度

示例值:false
DrainStatus String

节点驱逐状态

示例值:null
NodePoolId String

节点所属节点池

示例值:null
AdvancedSetting Object

节点高级设置

DataDisk Object

数据盘挂载设置

AutoFormatAndMount Boolean

是否对数据盘格式化并挂载

示例值:true
FileSystem String

数据盘的文件系统

示例值:ext4
MountTarget String

数据盘挂载点

示例值:/data
ContainerRuntime String

容器运行时,根据集群版本和需求选择

示例值:docker
DockerPath String

容器的存储路径

示例值:/data/docker
ContainerPath String

容器的存储路径

示例值:/data/container
UserScript String

base64编码的用户脚本

示例值:null
PreUserScript String

base64编码的用户脚本

示例值:null
Schedulable Boolean

节点加入集群后是否可以正常调度

示例值:true
Label Object[]

标签信息

Key String

标签键

示例值:test
Value String

标签值

示例值:test
ExtraArg Object

自定义节点上k8s组件的参数

Kubelet String[]

自定义节点上k8s组件的参数

示例值:null
ContainerLogMaxSize Int

自定义容器日志采集文件大小,超出此大小日志将滚动写入下一文件,默认值为100m

示例值:100
ContainerLogMaxFiles Int

自定义容器日志采集文件最大数量,默认值为10个

示例值:10
EpcInstancePara Object

物理机节点配置信息

ProjectId Int

实例所属项目ID

示例值:0
InstanceType String

物理机机型

示例值:CAL
Cpu Object

cpu相关信息

Model String

CPU型号

示例值:Intel_4216*2
Frequence String

CPU主频

示例值:null
Count Int

CPU个数

示例值:2
CoreCount Int

CPU核数

示例值:64
Memory String

内存大小

示例值:128G
Gpu Object

Gpu相关信息

Model String

GPU型号

Frequence String

显存大小

Count Int

CUDA核心数

CoreCount Int

计算能力

DiskSet Object[]

磁盘信息

DiskType String

磁盘类型

示例值:Data
Raid String

数据盘Raid级别

示例值:Raid1
Space String

磁盘可用容

示例值:480G
OsName String

镜像名称

示例值:CentOS-7.9-x86_64
ImageId String

镜像id

示例值:3eecbe68-1bc6-45c0-88ed-8434ccb7b83b
CreateTime String

实例创建时间

示例值:2023-05-1017:12:00
AvailabilityZone String

示例所在可用区

示例值:cn-beijing-6a
NetworkInterfaceSet Object[]

关联的网卡信息

NetworkInterfaceId String

网卡id

示例值:b4a083c8-de8d-c533-f75c-0b28131e376d
NetworkInterfaceType String

网卡的类型

示例值:primary
SubnetId String

子网id

示例值:2ff825c5-da33-5010-527f-17ce1fdbe47b
PrivateIpAddress String

服务器的网卡在vpc中的IP

示例值:10.0.13.11
MacAddress String

服务器MAC

示例值:40:a6:b7:7a:1f:f0
SecurityGroupSet Object[]

安全组信息

SecurityGroupId String

安全组的ID

示例值:5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7
EnableContainer Boolean

是否支持加入容器

示例值:false
ProductType String

EPC类型

示例值:lease
Type String

实例类型

  • kec 云服务器实例
  • dvm 专属云服务器实例
  • epc 物理机实例
示例值:kec
ErrorMessage String

节点异常原因简要描述

NodeName String

节点名称

RequestId String

请求id

示例值:container-04dd3f00-0ef2-48a4-9edf-8d14b4a19f8d
MaxResults Int

单页调用返回的最大实例数。

示例值:10
Marker Int

分页标识,如果调用未返回全部实例,标记下次调用的返回值的起点,如果已返回全部实例,则其值为0。

示例值:0
TotalCount Int

集群内节点实例个数(包括master和worker节点)。

示例值:6

请求示例

curl -X GET|POST
'http://kce.api.ksyun.com/?Action=DescribeClusterInstance&Version=2019-08-06'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/x-www-form-urlencoded'
-H 'host: kce.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d 'ClusterId=xxx&MaxResults=xxx&Marker=xxx&Filter.N.Name=xxx&Filter.N.Value.N=xxx&Search=xxx'

返回示例

JSON格式

{
"InstanceSet":[
{
"InstanceId":"6f2faec7-057f-455f-a45c-xxxxxx",
"InstanceName":"openapi-worker-1",
"NodeName":"10.2.2.3",
"InstanceRole":"Worker",
"InstanceStatus":"normal",
"KecInstancePara":{
"ProjectId":0,
"InstanceType":"I3.4B",
"InstanceConfigure":{
"VCPU":4,
"MemoryGb":8,
"GPU":0,
"DataDiskGb":50,
"RootDiskGb":20,
"DataDiskType":"SSD"
},
"SystemDisk":{
"DiskType":"Local_SSD",
"DiskSize":20
},
"ImageId":"5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7",
"PrivateIpAddress":"10.0.22.28",
"ChargeType":"Daily",
"CreateTime":"2019-09-10T15:22:43Z",
"AvailabilityZone":"cn-beijing-6b",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"VpcId":"31e21dca-c92e-4b06-a8ce-xxxxxx",
"NetworkInterfaceSet":[
{
"NetworkInterfaceId":"9b80391e-a720-40de-95d2-xxxxxx",
"NetworkInterfaceType":"primary",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"PrivateIpAddress":"10.0.22.28",
"MacAddress":"fa:16:3e:0e:0a:f8",
"SecurityGroupSet":[
{
"SecurityGroupId":"d46c7672-7ca9-4f51-bbd9-xxxxxx"
}
]
}
]
}
},
{
"InstanceId":"7c7c7003-1004-4b1b-a1c5-xxxxxx",
"InstanceName":"openapi-worker-2",
"InstanceRole":"Worker",
"InstanceStatus":"normal",
"KecInstancePara":{
"ProjectId":0,
"InstanceType":"I3.4B",
"InstanceConfigure":{
"VCPU":4,
"MemoryGb":8,
"GPU":0,
"DataDiskGb":50,
"RootDiskGb":20,
"DataDiskType":"SSD"
},
"SystemDisk":{
"DiskType":"Local_SSD",
"DiskSize":20
},
"ImageId":"5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7",
"PrivateIpAddress":"10.0.22.29",
"ChargeType":"Daily",
"CreateTime":"2019-09-10T15:22:43Z",
"AvailabilityZone":"cn-beijing-6b",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"VpcId":"31e21dca-c92e-4b06-a8ce-xxxxxx",
"NetworkInterfaceSet":[
{
"NetworkInterfaceId":"93ae1d49-3410-4dea-a9ef-xxxxxx",
"NetworkInterfaceType":"primary",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"PrivateIpAddress":"10.0.22.29",
"MacAddress":"fa:16:3e:68:ea:b1",
"SecurityGroupSet":[
{
"SecurityGroupId":"d46c7672-7ca9-4f51-bbd9-xxxxxx"
}
]
}
]
}
},
{
"InstanceId":"7dac9e5d-1325-4b66-83c0-xxxxxx",
"InstanceName":"openapi-master-2",
"InstanceRole":"Master_Etcd",
"InstanceStatus":"normal",
"KecInstancePara":{
"ProjectId":0,
"InstanceType":"I3.4B",
"InstanceConfigure":{
"VCPU":4,
"MemoryGb":8,
"GPU":0,
"DataDiskGb":50,
"RootDiskGb":20,
"DataDiskType":"SSD"
},
"SystemDisk":{
"DiskType":"Local_SSD",
"DiskSize":20
},
"ImageId":"5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7",
"PrivateIpAddress":"10.0.22.5",
"ChargeType":"Daily",
"CreateTime":"2019-09-10T15:22:41Z",
"AvailabilityZone":"cn-beijing-6b",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"VpcId":"31e21dca-c92e-4b06-a8ce-xxxxxx",
"NetworkInterfaceSet":[
{
"NetworkInterfaceId":"1e76aa20-0372-4eb1-b746-xxxxxx",
"NetworkInterfaceType":"primary",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"PrivateIpAddress":"10.0.22.5",
"MacAddress":"fa:16:3e:54:2d:58",
"SecurityGroupSet":[
{
"SecurityGroupId":"d46c7672-7ca9-4f51-bbd9-xxxxxx"
}
]
}
]
}
},
{
"InstanceId":"a33e44b5-471a-4edf-82e2-xxxxxx",
"InstanceName":"openapi-master-3",
"InstanceRole":"Master_Etcd",
"InstanceStatus":"normal",
"KecInstancePara":{
"ProjectId":0,
"InstanceType":"I3.4B",
"InstanceConfigure":{
"VCPU":4,
"MemoryGb":8,
"GPU":0,
"DataDiskGb":50,
"RootDiskGb":20,
"DataDiskType":"SSD"
},
"SystemDisk":{
"DiskType":"Local_SSD",
"DiskSize":20
},
"ImageId":"5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7",
"PrivateIpAddress":"10.0.22.3",
"ChargeType":"Daily",
"CreateTime":"2019-09-10T15:22:41Z",
"AvailabilityZone":"cn-beijing-6b",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"VpcId":"31e21dca-c92e-4b06-a8ce-xxxxxx",
"NetworkInterfaceSet":[
{
"NetworkInterfaceId":"4e92322a-4526-4d5d-b74b-xxxxxx",
"NetworkInterfaceType":"primary",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"PrivateIpAddress":"10.0.22.3",
"MacAddress":"fa:16:3e:74:f7:78",
"SecurityGroupSet":[
{
"SecurityGroupId":"d46c7672-7ca9-4f51-bbd9-xxxxxx"
}
]
}
]
}
},
{
"InstanceId":"f399f0d1-8388-427f-b2d7-xxxxxx",
"InstanceName":"openapi-worker-3",
"InstanceRole":"Worker",
"InstanceStatus":"normal",
"KecInstancePara":{
"ProjectId":0,
"InstanceType":"I3.4B",
"InstanceConfigure":{
"VCPU":4,
"MemoryGb":8,
"GPU":0,
"DataDiskGb":50,
"RootDiskGb":20,
"DataDiskType":"SSD"
},
"SystemDisk":{
"DiskType":"Local_SSD",
"DiskSize":20
},
"ImageId":"5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7",
"PrivateIpAddress":"10.0.22.14",
"ChargeType":"Daily",
"CreateTime":"2019-09-10T15:22:43Z",
"AvailabilityZone":"cn-beijing-6b",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"VpcId":"31e21dca-c92e-4b06-a8ce-xxxxxx",
"NetworkInterfaceSet":[
{
"NetworkInterfaceId":"b5088e71-3514-48b2-aa26-xxxxxx",
"NetworkInterfaceType":"primary",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"PrivateIpAddress":"10.0.22.14",
"MacAddress":"fa:16:3e:68:fa:98",
"SecurityGroupSet":[
{
"SecurityGroupId":"d46c7672-7ca9-4f51-bbd9-xxxxxx"
}
]
}
]
}
},
{
"InstanceId":"feec18d8-9562-446d-9894-xxxxxx",
"InstanceName":"openapi-master-1",
"InstanceRole":"Master_Etcd",
"InstanceStatus":"normal",
"KecInstancePara":{
"ProjectId":0,
"InstanceType":"I3.4B",
"InstanceConfigure":{
"VCPU":4,
"MemoryGb":8,
"GPU":0,
"DataDiskGb":50,
"RootDiskGb":20,
"DataDiskType":"SSD"
},
"SystemDisk":{
"DiskType":"Local_SSD",
"DiskSize":20
},
"ImageId":"5bbc21d6-c48c-4c8a-b057-fcbb164bcbf7",
"PrivateIpAddress":"10.0.22.27",
"ChargeType":"Daily",
"CreateTime":"2019-09-10T15:22:41Z",
"AvailabilityZone":"cn-beijing-6b",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"VpcId":"31e21dca-c92e-4b06-a8ce-xxxxxx",
"NetworkInterfaceSet":[
{
"NetworkInterfaceId":"fd4c03c6-10ef-42cc-81c5-xxxxxx",
"NetworkInterfaceType":"primary",
"SubnetId":"7e23b980-11c2-4bb0-9388-xxxxxx",
"PrivateIpAddress":"10.0.22.27",
"MacAddress":"fa:16:3e:49:7c:ac",
"SecurityGroupSet":[
{
"SecurityGroupId":"d46c7672-7ca9-4f51-bbd9-xxxxxx"
}
]
}
]
}
}
],
"RequestId":"container-04dd3f00-0ef2-48a4-9edf-8d14b4a19f8d",
"MaxResults":10,
"Marker":0,
"TotalCount":6
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
ClusterIdInvalidClusterId must match `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$`400集群ID必须满足 `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$`
MarkerInvalidMarker must be greater or equal to 0400Marker必须大于等于0
MaxResultsInvalidMaxResults must be equal or less than 50400MaxResults必须小于等于50
FilterValueRequiredFilterValue is required400FilterValue必须填写
InstanceIdInvalidInstanceId must match `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$`400实例ID必须满足 `^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$`
ClusterNotFoundcluster xx is not found400集群xx不存在
GetClusterErrorfailed to get cluster400获取集群信息失败
GetInstanceByNameFailedget instance by name error, result is too much400根据名称获取kec或epc实例失败,数据太多,超过了1000
纯净模式常规模式

纯净模式

点击可全屏预览文档内容