查看集群详情

接口描述

接口请求地址：https://kes.region.api.ksyun.com
调用DescribeCluster，查看指定ES集群的详细信息
默认接口请求频率限制：30次/秒

输入参数

名称	类型	是否可缺省	示例	有效值	备注
ClusterId	string	是	uuid		集群ID

输出参数

名称	类型	是否可缺省	示例	有效值	备注
RequestId	string	YES	uuid	任务ID
ErrorCode	int	NO	200	参考通用错误码定义
ErrorMessage	string	NO	error/parmaters	如果是同步请求，随请求返回
ClusterId	string	YES	uuid	集群ID
ClusterName	string	YES	test-es	集群名称
MainVersion	string	YES	6.8.3	ES版本号
InstanceGroups	object[]	YES		节点组列表标识
–InstanceGroupType	string	YES	MASTER 节点类型	MASTER ,DATA ,COORDINATOR, WARM
–ResourceType	string	NO	KEC	资源类型	KEC/EPC/CONTAINER，默认KEC
–InstanceType	string	YES	I3.2b	设备类型，与云主机等类型一致
–InstanceCount	int	YES	3	目标创建实例数量
–VolumeSize	int	是	5000	20-16000	存储大小，单位为G。MASTER（专有主节点）、COORDINATOR（协调节点）大小默认为20G
–VolumeType	string	是	SSD3.0	Local_SSD	存储类型，Master（专有主节点）、COORDINATOR（协调节点）、WARM（冷数据节点）支支持SSD3.0仅支持SSD3.0
EnableEip	boolean	NO	true	是否开启集群公网EIP
Eip	string	NO	120.0.0.1	EIP
Region	string	YES	cn-beijing-6
AvailabilityZone	string	YES	cn-beijing-6a	集群级别的可用区
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	集群过期时间
ClusterStatus	string	YES	RUNNING 集群状态
CreateTime	string	YES	2020-03-02 01:01:01	集群创建时间
UpdateTime	string	YES
ServingMinutes	int	YES	3333	集群自启动到现在运行分钟数
ProxyPort	int	NO	28291	访问代理port
ProxyUrlSuffix	string	NO	xxxxx 访问代理url前缀
ProxyService	[]	NO	{}	访问代理的具体service地址
SlbId	string	NO	uuid	如果有slbid，则返回

示例

输入示例

curl -X POST http://127.0.0.1:28081/kes/v1/DescribeCluster -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 
'{
	ClusterId: "uuid"
   }'

输出示例

{
    RequestId: "uuid",
    ErrorCode: 200,
    ErrorMessage: "",
     
    ClusterName: "xxx",
    ClusterId:"uuid",
    MainVersion: "6.8.3",
     
    InstanceGroups: [
                        {
                            InstanceGroupType: "MASTER",
                            ResourceType: "KEC",
                            InstanceType: "ES.basic.8C16G",
                            VolumeType: "SSD3.0",
                            VolumeSize: 20,
                            InstanceCount: 3,
                            
                        },{
                            InstanceGroupType: "CORE",
                            ResourceType: "KEC|EPC|CONTAINER",
                            InstanceType: "kmr.2x | I3.2b",
                            InstanceCount: 3
                           
                        }
                    ],
    
    Eip: "10.0.0.1",
    AvailabilityZone: "cn-beijing-6a",
    VpcDomainId: "uuid",
    VpcSubnetId: "uuid",
    VpcEndPointId: "uuid",
    BillingType: "",
    PurchaseTime: "",
    ExpireTime: "",
 
 
    ClusterStatus: "RUNNING|INIT",
    CreateTime: "2020-01-01 02:03:09",
    ServingMinutes: 4444
     
    //KES
     
    ProxyPort: 28291,
    ProxyUrlSuffix: "xxxxxxxxx",
    ProxyServices: [
        {
            Name: "kibana",
            Service; "xxx.com:5601"
        }
    ],
    SlbId: "uuid"
}