{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ClusterList":{"description":"集群对象。","properties":{"actionProgress":{"description":"集群行为进度,显示创建或扩容进度的百分比等。CREATING表示创建的百分比。","type":"object"},"actions":{"description":"集群当前行为。REBOOTING表示重启、GROWING表示扩容、RESTORING表示恢复集群、SNAPSHOTTING表示创建快照等。","items":{"type":"string"},"type":"array"},"authorityEnable":{"description":"是否开启认证。\n- true:表示集群开启认证。\n- false:表示集群不开启认证。","type":"boolean"},"backupAvailable":{"description":"快照是否开启。\n- true: 快照开启状态。\n- false: 快照关闭状态。","type":"boolean"},"bandwidthResourceId":{"description":"es公网访问的资源id。","type":"string"},"bandwidthSize":{"description":"公网带宽大小。单位:Mbit/s","format":"int32","type":"integer"},"created":{"description":"集群创建时间,格式为ISO8601:CCYY-MM-DDThh:mm:ss。\n\n返回的集群列表信息按照创建时间降序排序,即创建时间最新的集群排在最前。","type":"string"},"datastore":{"$ref":"#/definitions/ClusterListDatastore"},"diskEncrypted":{"description":"磁盘是否加密。\n\n- true : 磁盘已加密。\n- false : 磁盘未加密。","type":"boolean"},"elbWhiteList":{"$ref":"#/definitions/elbWhiteListResp","description":"弹性IP白名单列表。"},"endpoint":{"description":"用户VPC访问IP地址和端口号。","type":"string"},"enterpriseProjectId":{"description":"集群所属的企业项目ID。\n如果集群所属用户没有开通企业项目,则不会返回该参数。","type":"string"},"failedReason":{"$ref":"#/definitions/ClusterListFailedReasons"},"httpsEnable":{"description":"通信加密状态。\n- false:未设置通信加密。\n- true:已设置通信加密。","type":"boolean"},"id":{"description":"集群ID。","type":"string"},"instances":{"description":"节点对象列表。","items":{"$ref":"#/definitions/ClusterListInstances"},"type":"array"},"name":{"description":"集群名称。","type":"string"},"period":{"description":"是否为包周期集群。\n- \"true\" 表示是包周期计费的集群。\n- \"false\" 表示是按需计费的集群。","type":"boolean"},"publicIp":{"description":"公网IP信息。","type":"string"},"publicKibanaResp":{"$ref":"#/definitions/publicKibanaRespBody","description":"Kibana公网访问信息。"},"securityGroupId":{"description":"安全组ID。","type":"string"},"status":{"description":"集群状态值。\n\n- 100:创建中。\n- 200:可用。\n- 303:不可用,如创建失败。","type":"string"},"subnetId":{"description":"子网ID。","type":"string"},"tags":{"description":"集群标签。","items":{"$ref":"#/definitions/ClusterListTags"},"type":"array"},"updated":{"description":"集群上次修改时间,格式为ISO8601: CCYY-MM-DDThh:mm:ss。","type":"string"},"vpcId":{"description":"VPC ID。","type":"string"}},"type":"object"},"ClusterListDatastore":{"description":"数据搜索引擎类型。","properties":{"type":{"description":"引擎类型,目前只支持elasticsearch。","type":"string"},"version":{"description":"CSS集群引擎版本号。详细请参考CSS[支持的集群版本](css_03_0056.xml)。","type":"string"}}},"ClusterListFailedReasons":{"description":"失败原因。如果集群处于正常状态,则不返回该参数。","properties":{"errorCode":{"description":"错误码。\n\n- CSS.6000:表示集群创建失败。\n- CSS.6001:表示集群扩容失败。\n- CSS.6002:表示集群重启失败。\n- CSS.6004:表示集群节点创建失败。\n- CSS.6005:表示服务初始化失败。","type":"string"},"errorMsg":{"description":"详细错误信息。","type":"string"}}},"ClusterListInstances":{"description":"节点对象。","properties":{"azCode":{"description":"节点所属AZ信息。","type":"string"},"id":{"description":"实例ID。","type":"string"},"ip":{"description":"实例ip信息。","type":"string"},"name":{"description":"实例名字。","type":"string"},"resourceId":{"description":"该实例对应的资源Id。","type":"string"},"specCode":{"description":"节点规格名称。","type":"string"},"status":{"description":"节点状态值。\n\n- 100:创建中。\n- 200:可用。\n- 303:不可用,如创建失败。","type":"string"},"type":{"description":"当前节点的类型。","pattern":"ess","type":"string"},"volume":{"$ref":"#/definitions/ClusterVolumeRsp"}},"type":"object"},"ClusterListResponse":{"properties":{"clusters":{"description":"集群对象列表。","items":{"$ref":"#/definitions/ClusterList"},"type":"array"},"totalSize":{"description":"集群个数。","type":"integer"}}},"ClusterListTags":{"description":"集群标签。","properties":{"key":{"description":"集群标签的key值。","type":"string"},"value":{"description":"集群标签的value值。","type":"string"}}},"ClusterVolumeRsp":{"description":"实例磁盘信息。","properties":{"resourceIds":{"description":"该实例拥有的磁盘对应的资源Id。","items":{"type":"string"},"type":"array"},"size":{"description":"实例磁盘大小。","type":"integer"},"type":{"description":"实例磁盘类型。","type":"string"}},"type":"object"},"elbWhiteListResp":{"description":"公网访问信息。","properties":{"enableWhiteList":{"description":"是否开启公网访问控制。\n- true: 开启公网访问控制。\n- false: 关闭公网访问控制。","type":"boolean"},"whiteList":{"description":"公网访问白名单。","type":"string"}}},"kibanaElbWhiteListResp":{"description":"Kibana公网访问信息。","properties":{"enableWhiteList":{"description":"是否开启kibana访问控制。\n- true: 开启访问控制。\n- false: 关闭访问控制","type":"boolean"},"whiteList":{"description":"kibana公网访问白名单。","type":"string"}}},"publicKibanaRespBody":{"description":"Kibana公网访问信息。","properties":{"bandwidthResourceId":{"description":"当前kibana公网对应的资源Id。","type":"string"},"eipSize":{"description":"带宽大小。单位:Mbit/s","type":"integer"},"elbWhiteListResp":{"$ref":"#/definitions/kibanaElbWhiteListResp"},"publicKibanaIp":{"description":"kibana访问IP。","type":"string"}},"type":"object"}},"description":null,"group_id":"c917c7a19aa04328b7e47a1def0e0acd","host":"css.cn-north-4.myhuaweicloud.com","id":"32e5b45213684796bb2138f056b1308c","info_version":"v1","method":"get","name":"ListClustersDetails","parameters":{},"paths":{"/v1.0/{project_id}/clusters":{"get":{"description":"该接口用于查询并显示集群列表以及集群的状态。","operationId":"ListClustersDetails","parameters":[{"description":"项目ID。获取方法请参见[获取项目ID和名称](css_03_0071.xml)。","in":"path","name":"project_id","required":true,"type":"string","x-example":"6204a5bd270343b5885144cf9c8c158d"},{"description":"指定查询起始值,默认值为1,即从第1个集群开始查询。","in":"query","name":"start","required":false,"type":"integer","x-example":1},{"description":"指定查询个数,默认值为10,即一次查询10个集群信息。","in":"query","name":"limit","required":false,"type":"integer","x-example":10}],"responses":{"200":{"description":"请求已成功。","schema":{"$ref":"#/definitions/ClusterListResponse"},"x-response-examples-1":{"application/json":{"clusters":[{"actionProgress":{},"actions":[],"authorityEnable":false,"backupAvailable":false,"bandwidthSize":0,"created":"2023-01-11T06:48:22","datastore":{"type":"elasticsearch","version":"7.10.2"},"diskEncrypted":false,"elbWhiteList":{"enableWhiteList":false,"whiteList":""},"endpoint":"192.168.0.100:9200","httpsEnable":false,"id":"{CLUSTER_ID}","instances":[{"azCode":"{AZ_CODE}","id":"{INSTANCE_ID}","ip":"192.168.0.100","name":"css-test-ess-esn-1-1","resourceId":"f0b26c12-eda7-4758-8b76-c891bd10abee","specCode":"ess.spec-4u16g","status":"200","type":"ess","volume":{"resourceIds":["26c365a0-f114-4810-b3b1-b87c0ac077a6"],"size":40,"type":"COMMON"}}],"name":"css-test","period":false,"publicIp":null,"publicKibanaResp":null,"securityGroupId":"{SECURITY_GROUP_ID}","status":"200","subnetId":"{SUBNET_ID}","tags":[],"updated":"2023-01-11T08:19:14","vpcId":"{VPC_ID}"},{"actionProgress":{},"actions":[],"authorityEnable":false,"backupAvailable":false,"bandwidthSize":0,"created":"2023-01-11T06:48:22","datastore":{"type":"elasticsearch","version":"7.9.3"},"diskEncrypted":false,"elbWhiteList":{"enableWhiteList":false,"whiteList":""},"endpoint":"192.168.0.101:9200","httpsEnable":false,"id":"{CLUSTER_ID}","instances":[{"azCode":"{AZ_CODE}","id":"{INSTANCE_ID}","ip":"192.168.0.100","name":"css-new-ess-esn-1-1","resourceId":"f0b26c12-eda7-4758-8b76-c891bd10abee","specCode":"ess.spec-4u16g","status":"200","type":"ess","volume":{"resourceIds":["26c365a0-f114-4810-b3b1-b87c0ac077a6"],"size":40,"type":"COMMON"}}],"name":"css-new","period":false,"publicIp":null,"publicKibanaResp":null,"securityGroupId":"{SECURITY_GROUP_ID}","status":"200","subnetId":"{SUBNET_ID}","tags":[],"updated":"2023-01-11T08:19:14","vpcId":"{VPC_ID}"}],"totalSize":2}}},"400":{"description":"非法请求。\n\n建议直接修改该请求,不要重试该请求。"},"404":{"description":"所请求的资源不存在。\n\n建议直接修改该请求,不要重试该请求。"}},"summary":"查询集群列表","tags":["集群管理接口"],"x-apiexplorer-hide":"N","x-is-registered":"Y","x-order":1,"x-publishpath":"","x-request-examples-description-1":"全部查询请求样例","x-request-examples-description-2":"查询前2个集群","x-request-examples-description-3":"查询前10个集群","x-request-examples-url":"GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters","x-request-examples-url-2":"- 方法1:GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=2\n\n- 方法2:GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=2","x-request-examples-url-3":"- 方法1:GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=10\n\n- 方法2:GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=10","x-support-sdk":"Y"}}},"product_short":"CSS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询集群列表","tags":"集群管理接口","uri":null,"version":"2.0"}