huawei-cloud-api-definitions-CSS 0.1.20240216

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ClusterDetailDatastore":{"description":"数据搜索引擎类型。","properties":{"type":{"description":"引擎类型,目前只支持elasticsearch。","example":"elasticsearch","type":"string"},"version":{"description":"CSS集群引擎版本号。详细请参考CSS[支持的集群版本](css_03_0056.xml)。","type":"string"}}},"ClusterDetailFailedReasons":{"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"}}},"ClusterDetailInstances":{"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/ShowClusterVolumeRsp"}},"type":"object"},"ClusterDetailResponse":{"description":"cluster detail info response","example":{"actionProgress":{},"actions":[],"created":"2018-01-16T08:37:18","datastore":{"type":"elasticsearch","version":"x.x.x"},"elbWhiteList":{"enableWhiteList":true,"whiteList":"10.10.10.10"},"endpoint":"192.168.0.8:9200","enterpriseProjectId":"3e1c74a0-xxx-xxx-xxx-c6b9e46cf81b","id":"5c77b71c-xxx-xxx-xxx-76387e42451a","instances":{"id":"3c7fe582-xxx-xxx-xxx-956bed4a8bbc","name":"ES-1-16-test17-ess-esn-1-1","status":"200","type":"ess"},"name":"ES-1-16-test17","publicIp":"100.95.149.136:9200","publicKibanaResp":{"eipSize":5,"elbWhiteList":{"enableWhiteList":true,"whiteList":"11.11.11.11"},"publicKibanaIp":"100.95.158.2"},"status":"200","tags":[{"key":"k1","value":"v1"}],"updated":"2018-01-16T08:37:18"},"properties":{"actionProgress":{"description":"集群行为进度,显示创建或扩容进度的百分比。","type":"object"},"actions":{"description":"集群当前行为。REBOOTING表示重启、GROWING表示扩容、RESTORING表示恢复集群、SNAPSHOTTING表示创建快照等。","items":{"type":"string"},"type":"array"},"authorityEnable":{"description":"是否开启认证,取值范围为true或false。默认关闭认证功能。\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。","type":"string"},"datastore":{"$ref":"#/definitions/ClusterDetailDatastore"},"diskEncrypted":{"description":"磁盘是否加密。\n\n- true : 磁盘已加密。\n- false : 磁盘未加密。","type":"boolean"},"elbWhiteList":{"$ref":"#/definitions/elbWhiteListResp","description":"公网访问信息。"},"endpoint":{"description":"用户VPC访问IP地址和端口号。","type":"string"},"enterpriseProjectId":{"description":"集群所属的企业项目ID。\n\n如果集群所属用户没有开通企业项目,则不会返回该参数。","type":"string"},"failedReason":{"$ref":"#/definitions/ClusterDetailFailedReasons","description":"失败原因。如果集群处于正常状态,则不返回该参数。"},"httpsEnable":{"description":"通信加密状态。\n- false:未设置通信加密。\n- true:已设置通信加密。","type":"boolean"},"id":{"description":"集群ID。","type":"string"},"instances":{"description":"节点对象列表。","items":{"$ref":"#/definitions/ClusterDetailInstances"},"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/ClusterDetailTags"},"type":"array"},"updated":{"description":"集群上次修改时间,格式为ISO8601: CCYY-MM-DDThh:mm:ss。","type":"string"},"vpcId":{"description":"VPC ID。","type":"string"},"vpcepIp":{"description":"终端节点IP。","type":"string"}},"type":"object"},"ClusterDetailTags":{"description":"集群标签。","properties":{"key":{"description":"集群标签的key值。","type":"string"},"value":{"description":"集群标签的value值。","type":"string"}}},"ShowClusterVolumeRsp":{"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":"14627b9e556a45d1aae8401588c34119","info_version":"v1","method":"get","name":"ShowClusterDetail","parameters":{},"paths":{"/v1.0/{project_id}/clusters/{cluster_id}":{"get":{"description":"该接口用于查询并显示单个集群详情。","operationId":"ShowClusterDetail","parameters":[{"description":"项目ID。获取方法请参见[获取项目ID和名称](css_03_0071.xml)。","in":"path","name":"project_id","required":true,"type":"string","x-example":"6204a5bd270343b5885144cf9c8c158d"},{"description":"指定查询集群ID。","in":"path","name":"cluster_id","required":true,"type":"string","x-example":"5c77b71c-5b35-4f50-8984-76387e42451a"}],"responses":{"200":{"description":"请求已成功。","examples":{"application/json":{"actionProgress":{},"actions":[],"authorityEnable":true,"backupAvailable":true,"bandwidthSize":0,"created":"2018-01-16T08:37:18","datastore":{"type":"elasticsearch","version":"x.x.x"},"diskEncrypted":false,"elbWhiteList":{"enableWhiteList":true,"whiteList":"10.10.10.10"},"endpoint":"192.168.0.x:9200","enterpriseProjectId":"3e1c74a0-xxx-xxx-xxx-c6b9e46cf81b","httpsEnable":true,"id":"5c77b71c-5b35-4f50-8984-76387e42451a","instances":[{"azCode":"xx-xxx-xx","id":"3c7fe582-a9f6-46fd-9d01-956bed4a8bbc","ip":"192.168.0.x","name":"ES-1-16-test17-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","5f51a3e2-bb2b-47a2-9db2-5bc0eae84858","a52cd442-f7d4-4efd-b191-4562f81d6912","e2ba53da-56f2-4382-8a27-e90e4fa4d67e"],"size":40,"type":"COMMON"}}],"name":"ES-1-16-test17","period":false,"publicIp":"100.95.149.xx:9200","publicKibanaResp":{"bandwidthResourceId":"7e340e9d-5b07-4bbf-9e0d-e31e06bb2765","eipSize":5,"elbWhiteListResp":{"enableWhiteList":true,"whiteList":"11.11.11.11"},"publicKibanaIp":"100.95.158.x"},"securityGroupId":"0347aabc-xxx-xxx-xxx-6b10a79701e2","status":"200","subnetId":"025d45f9-xxx-xxx-xxx-e852c6455a5e","tags":[{"key":"k1","value":"v1"}],"updated":"2018-01-16T08:37:18","vpcId":"07e7ab39-xxx-xxx-xxx-d3f28ea7f051","vpcepIp":"192.168.0.203"}},"schema":{"$ref":"#/definitions/ClusterDetailResponse"}},"400":{"description":"非法请求。\n\n建议直接修改该请求,不要重试该请求。"},"404":{"description":"所请求的资源不存在。\n\n建议直接修改该请求,不要重试该请求。"}},"summary":"查询集群详情","tags":["集群管理接口"],"x-apiexplorer-hide":"N","x-is-registered":"Y","x-order":2,"x-publishpath":"","x-request-examples-url":"GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/5c77b71c-5b35-4f50-8984-76387e42451a","x-support-sdk":"Y"}}},"product_short":"CSS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询集群详情","tags":"集群管理接口","uri":null,"version":"2.0"}