查询集群详情
功能介绍
该接口用于查询并显示单个集群详情。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
cluster_id |
是 |
String |
指定查询集群ID。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
datastore |
ClusterDetailDatastore object |
数据搜索引擎类型。 |
instances |
Array of ClusterDetailInstances objects |
节点对象列表。 |
publicKibanaResp |
publicKibanaRespBody object |
Kibana公网访问信息。 |
elbWhiteList |
elbWhiteListResp object |
公网访问信息。 |
updated |
String |
集群上次修改时间,格式为ISO8601: CCYY-MM-DDThh:mm:ss。 |
name |
String |
集群名称。 |
publicIp |
String |
公网IP信息。 |
created |
String |
集群创建时间,格式为ISO8601: CCYY-MM-DDThh:mm:ss。 |
id |
String |
集群ID。 |
status |
String |
集群状态值。
|
endpoint |
String |
用户VPC访问IP地址和端口号。 |
vpcId |
String |
VPC ID。 |
subnetId |
String |
子网ID。 |
securityGroupId |
String |
安全组ID。 |
vpcepIp |
String |
终端节点IP。 |
bandwidthSize |
Integer |
公网带宽大小。单位:Mbit/s |
httpsEnable |
Boolean |
通信加密状态。
|
diskEncrypted |
Boolean |
磁盘是否加密。
|
authorityEnable |
Boolean |
是否开启认证,取值范围为true或false。默认关闭认证功能。
|
backupAvailable |
Boolean |
快照是否开启。
|
actionProgress |
Object |
集群行为进度,显示创建或扩容进度的百分比。 |
actions |
Array of strings |
集群当前行为。REBOOTING表示重启、GROWING表示扩容、RESTORING表示恢复集群、SNAPSHOTTING表示创建快照等。 |
enterpriseProjectId |
String |
集群所属的企业项目ID。 如果集群所属用户没有开通企业项目,则不会返回该参数。 |
tags |
Array of ClusterDetailTags objects |
集群标签。 |
failedReason |
ClusterDetailFailedReasons object |
失败原因。如果集群处于正常状态,则不返回该参数。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
引擎类型,目前只支持elasticsearch。 |
version |
String |
CSS集群引擎版本号。详细请参考CSS支持的集群版本。 |
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
节点状态值。
|
type |
String |
当前节点的类型。 |
id |
String |
实例ID。 |
name |
String |
实例名字。 |
specCode |
String |
节点规格名称。 |
azCode |
String |
节点所属AZ信息。 |
ip |
String |
实例ip信息。 |
volume |
ShowClusterVolumeRsp object |
实例磁盘信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
eipSize |
Integer |
带宽大小。单位:Mbit/s |
elbWhiteListResp |
kibanaElbWhiteListResp object |
Kibana公网访问信息。 |
publicKibanaIp |
String |
kibana访问IP。 |
参数 |
参数类型 |
描述 |
---|---|---|
enableWhiteList |
Boolean |
是否开启kibana访问控制。
|
whiteList |
String |
kibana公网访问白名单。 |
请求示例
无
响应示例
状态码: 200
请求已成功。
{ "datastore" : { "type" : "elasticsearch", "version" : "x.x.x" }, "instances" : [ { "status" : "200", "type" : "ess", "id" : "3c7fe582-a9f6-46fd-9d01-956bed4a8bbc", "name" : "ES-1-16-test17-ess-esn-1-1", "specCode" : "ess.spec-4u16g", "azCode" : "xx-xxx-xx", "ip" : "192.168.0.x", "volume" : { "type" : "COMMON", "size" : 40 } } ], "publicKibanaResp" : { "eipSize" : 5, "publicKibanaIp" : "100.95.158.x", "elbWhiteListResp" : { "whiteList" : "11.11.11.11", "enableWhiteList" : true } }, "updated" : "2018-01-16T08:37:18", "name" : "ES-1-16-test17", "publicIp" : "100.95.149.xx:9200", "elbWhiteList" : { "whiteList" : "10.10.10.10", "enableWhiteList" : true }, "created" : "2018-01-16T08:37:18", "id" : "5c77b71c-5b35-4f50-8984-76387e42451a", "status" : "200", "endpoint" : "192.168.0.x:9200", "vpcId" : "07e7ab39-xxx-xxx-xxx-d3f28ea7f051", "subnetId" : "025d45f9-xxx-xxx-xxx-e852c6455a5e", "securityGroupId" : "0347aabc-xxx-xxx-xxx-6b10a79701e2", "vpcepIp" : "192.168.0.203", "bandwidthSize" : 0, "diskEncrypted" : false, "httpsEnable" : true, "authorityEnable" : true, "backupAvailable" : true, "actionProgress" : { }, "actions" : [ ], "enterpriseProjectId" : "3e1c74a0-xxx-xxx-xxx-c6b9e46cf81b", "tags" : [ { "key" : "k1", "value" : "v1" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功。 |
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
404 |
所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。