全部文档
当前文档
最近更新时间：2023-08-29 11:15:46
接口请求地址：https://kes.region.api.ksyun.com
调用ListClusters，获取ES集群的列表信息
默认接口请求频率限制：30次/秒
| 名称 | 类型 | 是否可缺省 | 示例 | 有效值 | 备注 |
|---|---|---|---|---|---|
| Marker | string | NO | limit=10&offset=0 | 分页信息 |
| 名称 | 类型 | 是否可缺省 | 示例 | 有效值 | 备注 |
|---|---|---|---|---|---|
| Clusters | string[] | YES | [] | cluster信息标识 | |
| -ClusterId | string | YES | uuid | clusterid | |
| –ClusterName | string | YES | test-es | clustername | |
| –MainVersion | string | YES | opensource-6.8.3 | ES主版本号 | |
| InstanceGroups | object | YES | [] | 节点组列表标识 | |
| Id | string | YES | 38a4a3d9-cd6f-4910-a079-12ba6da92e41 | KES、KEC、EBS实例的ID | |
| InstanceGroupType | string | YES | MASTER 节点类型 MASTER ,DATA ,COORDINATOR, WARM | ||
| ResourceType | string | NO | KEC | 资源类型 | |
| InstanceType | string | YES | ES.basic.2C4G | 设备类型，与云主机等类型一致 | |
| InstanceCount | int | YES | 3 | 目标创建实例数量 | |
| EnableEip | boolean | NO | true | 是否开启集群公网EIP | |
| EipLineId | string | NO | bgp | EIP创建线路 | |
| EipChargeType | string | NO | Daily | Monthly(预付费)Daily(按日月结) | |
| Region | string | YES | cn-beijing-6 | ||
| AvailabilityZone | string | YES | cn-beijing-6cn-beijing-6b | 集群级别的可用区 | |
| VpcDomainId | string | YES | uuid | 集群级别的VPCID | |
| VpcSubnetId | string | YES | uuid | 集群级别子网ID | |
| ChargeType | string | YES | Monthly 集群级别计费类型 | ||
| PurchaseTime | int | NO | 3 | 集群购买时长 | |
| ExpireTime | string | NO | 2020-03-02 02:03:03 | 集群过期时间 | |
| ProjectId | string | NO | uuid | 项目ID | |
| ClusterStatus | string | YES | RUNNING | 集群状态 | |
| CreateTime | string | YES | 2020-03-02 01:01:01 | 集群启动时间 | |
| UpdateTime | string | YES | 2020-03-02 01:01:01 | 集群状态更新时间 | |
| ServingMinutes | int | YES | 3333 | 集群自启动到现在运行分钟数 | |
| Total | int | YES | 3333 | 集群数量 |
输入示例
curl -X POST http://127.0.0.1:28081/kes/v1/ListClusters -H 'X-Ksc-Account-Id: 73403574' -H 'X-Ksc-Region: cn-shanghai-3' -H 'X-Ksc-Source:user' -H 'X-Ksc-Request-Id: 0b09eb45-e650-4a6d-be49-14b533abcf64' -H 'X-Version: 2020-12-15' -d
'{
}'
输出示例
{
"Clusters": [
{
"ClusterId": "ab4cb251-5ac0-417e-b160-c27ad27671ca",
"ClusterName": "es-xzb-742",
"MainVersion": "OpenSource-7.4.2",
"InstanceGroups": [
{
"InstanceGroupType": "DATA",
"ResourceType": "KEC",
"InstanceType": "ES.basic.2C4G",
"InstanceCount": 3
}
],
"EnableEip": false,
"EipLineId": null,
"Region": "cn-beijing-6",
"AvailabilityZone": "cn-beijing-6a",
"VpcDomainId": "da03d553-13f5-47af-bd10-2ee916b01124",
"VpcSubnetId": "aedb564a-5768-4c19-9757-8af2f2ec06ba",
"VpcEpcSubnetId": null,
"ChargeType": "Daily",
"ExpireTime": null,
"ClusterStatus": "RUNNING",
"CreateTime": "2021-05-27 09:45:58",
"UpdateTime": "2021-05-27 09:51:29",
"ServingMinutes": 4152,
"BillingType": "Daily",
"ProjectInfo": {
"Id": 0,
"Name": "默认项目"
}
}
],
"Total": 14,
},
"message": "OK"
}
纯净模式