计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询集群详情

功能介绍

该接口用于查询并显示单个集群详情。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/clusters/{cluster_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID和名称

cluster_id

String

指定查询集群ID。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

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

集群状态值。

  • 100:操作进行中,如创建中。
  • 200:可用。
  • 303:不可用,如创建失败。

endpoint

String

集群内网访问IPv4地址和端口号。

vpcId

String

VPC ID。

subnetId

String

子网ID。

securityGroupId

String

安全组ID。

bandwidthSize

Integer

公网带宽大小。单位:Mbit/s

httpsEnable

Boolean

通信加密状态。

  • false:未设置通信加密。
  • true:已设置通信加密。

diskEncrypted

Boolean

磁盘是否加密。

  • true : 磁盘已加密。
  • false : 磁盘未加密。

authorityEnable

Boolean

是否开启认证,取值范围为true或false。默认关闭认证功能。

  • true:表示集群开启认证。
  • false:表示集群不开启认证。

backupAvailable

Boolean

快照是否开启。

  • true: 快照开启状态。
  • false: 快照关闭状态。

actionProgress

Object

集群行为进度,显示创建或扩容进度的百分比。

actions

Array of strings

集群当前行为。REBOOTING表示重启、GROWING表示扩容、RESTORING表示恢复集群、SNAPSHOTTING表示创建快照等。

enterpriseProjectId

String

集群所属的企业项目ID。

如果集群所属用户没有开通企业项目,则不会返回该参数。

tags

Array of ClusterDetailTags objects

集群标签。

failedReason

ClusterDetailFailedReasons object

失败原因。如果集群处于正常状态,则不返回该参数。

bandwidthResourceId

String

公网访问的资源id。

表3 ClusterDetailDatastore

参数

参数类型

描述

type

String

引擎类型,支持elasticsearch。

version

String

CSS集群引擎版本号。详细请参考CSS支持的集群版本

supportSecuritymode

Boolean

支持安全模式

表4 ClusterDetailInstances

参数

参数类型

描述

status

String

节点状态值。

  • 100:操作进行中,如创建中。
  • 200:可用。
  • 303:不可用,如创建失败。

resourceId

String

该实例对应的资源Id。

type

String

当前节点的类型。

id

String

实例ID。

name

String

实例名字。

specCode

String

节点规格名称。

azCode

String

节点所属AZ信息。

privateIp

String

实例ip信息。

volume

ShowClusterVolumeRsp object

实例磁盘信息。

表5 ShowClusterVolumeRsp

参数

参数类型

描述

type

String

实例磁盘类型。

size

Integer

实例磁盘大小。

resourceIds

Array of strings

该实例拥有的磁盘对应的资源Id。

表6 publicKibanaRespBody

参数

参数类型

描述

eipSize

Integer

带宽大小。单位:Mbit/s

elbWhiteListResp

kibanaElbWhiteListResp object

Kibana公网访问信息。

publicKibanaIp

String

kibana访问IP。

bandwidthResourceId

String

当前kibana公网对应的资源Id。

表7 kibanaElbWhiteListResp

参数

参数类型

描述

enableWhiteList

Boolean

是否开启kibana访问控制。

  • true: 开启访问控制。
  • false: 关闭访问控制

whiteList

String

kibana公网访问白名单。

表8 elbWhiteListResp

参数

参数类型

描述

enableWhiteList

Boolean

是否开启公网访问控制。

  • true: 开启公网访问控制。
  • false: 关闭公网访问控制。

whiteList

String

公网访问白名单。

表9 ClusterDetailTags

参数

参数类型

描述

key

String

集群标签的key值。

value

String

集群标签的value值。

表10 ClusterDetailFailedReasons

参数

参数类型

描述

errorCode

String

错误码。

  • CSS.6000:表示集群创建失败。
  • CSS.6001:表示集群扩容失败。
  • CSS.6002:表示集群重启失败。
  • CSS.6004:表示集群节点创建失败。
  • CSS.6005:表示服务初始化失败。

errorMsg

String

详细错误信息。

请求示例

响应示例

状态码: 200

请求已成功。

{
  "datastore" : {
    "type" : "elasticsearch",
    "version" : "7.10.2"
  },
  "instances" : [ {
    "status" : "200",
    "type" : "ess",
    "id" : "{INSTANCE_ID}",
    "name" : "css-8bc5-ess-esn-1-1",
    "specCode" : "ess.spec-4u8g",
    "azCode" : "{AZ_CODE}",
    "volume" : {
      "type" : "ULTRAHIGH",
      "size" : 40,
      "resourceIds" : [ "{RESOURCE_ID}" ]
    },
    "privateIp" : "192.168.0.122",
    "resourceId" : "{RESOURCE_ID}"
  } ],
  "publicKibanaResp" : {
    "eipSize" : 10,
    "publicKibanaIp" : "100.95.152.28",
    "elbWhiteListResp" : null,
    "bandwidthResourceId" : "18bec13f-5cc1-4631-867f-33505d15be12"
  },
  "elbWhiteList" : {
    "whiteList" : "",
    "enableWhiteList" : false
  },
  "updated" : "2023-10-09T02:07:13",
  "name" : "css-8bc5",
  "publicIp" : "100.85.222.202",
  "created" : "2023-10-09T02:07:13",
  "id" : "{CLUSTER_ID}",
  "status" : "200",
  "vpcId" : "{VPC_ID}",
  "subnetId" : "{SUBNET_ID}",
  "securityGroupId" : "{SECURITY_GROUP_ID}",
  "bandwidthResourceId" : "{BANDWIDTH_RESOURCE_ID}",
  "bandwidthSize" : 3,
  "httpsEnable" : true,
  "authorityEnable" : true,
  "diskEncrypted" : false,
  "backupAvailable" : false,
  "actionProgress" : { },
  "actions" : [ ],
  "enterpriseProjectId" : "0",
  "tags" : [ ]
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

404

所请求的资源不存在。

建议直接修改该请求,不要重试该请求。

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容