接口请求域名： es.intl.tencentcloudapi.com 。
查询集群各视图数据，包括集群维度、节点维度、Kibana维度
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeViews。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例ID |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterView | ClusterView | 集群维度视图 注意：此字段可能返回 null，表示取不到有效值。 |
| NodesView | Array of NodeView | 节点维度视图 注意：此字段可能返回 null，表示取不到有效值。 |
| KibanasView | Array of KibanaView | Kibana维度视图 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
查询集群视图
https://es.intl.tencentcloudapi.com/?Action=DescribeViews
&InstanceId=es-xxxxxxxx
&<公共请求参数>
{
"Response": {
"RequestId": "6127baed-bc4c-4c0d-b52d-6463a722795b",
"ClusterView": {
"Health": 0,
"NodeNum": 3,
"TotalNodeNum": 3,
"DataNodeNum": 3,
"IndexNum": 121,
"DocNum": 68195345,
"DiskUsedInBytes": 27909384217,
"ShardNum": 1033,
"PrimaryShardNum": 516,
"RelocatingShardNum": 0,
"InitializingShardNum": 0,
"UnassignedShardNum": 0,
"Visible": 1,
"Break": 0,
"AvgDiskUsage": 0.075802238966579,
"AvgMemUsage": 0.82355177962355,
"AvgCpuUsage": 0.0097774027927309,
"TotalDiskSize": 600,
"TotalCosStorage": 0,
"SearchableSnapshotCosBucket": "",
"SearchableSnapshotCosAppId": "",
"TargetNodeTypes": [
"data"
]
},
"NodesView": [
{
"NodeId": "1739331190000739932",
"NodeIp": "9.29.48.61",
"NodeHttpIp": "9.29.48.61",
"Zone": "ap-hongkong-3",
"Hidden": false,
"NodeRole": "hotData",
"Visible": 1,
"Break": 0,
"DiskSize": 200,
"DiskUsage": 0.075739699850416,
"MemSize": 8,
"MemUsage": 0.82319480451571,
"JvmMemUsage": 0.6,
"CpuNum": 4,
"CpuUsage": 0.0048451231329569,
"ShardNum": 345,
"DiskIds": [
"disk-6eur8xxx"
],
"IsCoordinationNode": true,
"CVMStatus": "RUNNING",
"CVMDisasterRecoverGroupId": "",
"CVMDisasterRecoverGroupStatus": 0
},
{
"NodeId": "1739331190000740032",
"NodeIp": "9.29.50.27",
"NodeHttpIp": "9.29.50.27",
"Zone": "ap-hongkong-3",
"Hidden": false,
"NodeRole": "hotData",
"Visible": 1,
"Break": 0,
"DiskSize": 200,
"DiskUsage": 0.076343043587719,
"MemSize": 8,
"MemUsage": 0.82361871962329,
"JvmMemUsage": 0.34,
"CpuNum": 4,
"CpuUsage": 0.0048869730840559,
"ShardNum": 344,
"DiskIds": [
"disk-0pwecycm"
],
"IsCoordinationNode": true,
"CVMStatus": "RUNNING",
"CVMDisasterRecoverGroupId": "",
"CVMDisasterRecoverGroupStatus": 0
},
{
"NodeId": "1739331190000739832",
"NodeIp": "9.29.51.17",
"NodeHttpIp": "9.29.51.17",
"Zone": "ap-hongkong-3",
"Hidden": false,
"NodeRole": "hotData",
"Visible": 1,
"Break": 0,
"DiskSize": 200,
"DiskUsage": 0.07533630210082,
"MemSize": 8,
"MemUsage": 0.8215642493271,
"JvmMemUsage": 0.62,
"CpuNum": 4,
"CpuUsage": 0.0041350619841615,
"ShardNum": 344,
"DiskIds": [
"disk-2xtqdaju"
],
"IsCoordinationNode": true,
"CVMStatus": "RUNNING",
"CVMDisasterRecoverGroupId": "",
"CVMDisasterRecoverGroupStatus": 0
}
],
"KibanasView": [
{
"Ip": "9.29.49.38",
"NodeId": "1739331190000739832",
"Zone": "ap-hongkong-3",
"DiskSize": 50,
"DiskUsage": 0.19899999999999998,
"MemSize": 2,
"MemUsage": 0.76055485347424,
"CpuNum": 1,
"CpuUsage": 0.029833333333333
}
]
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnAuthCreateInstance | 当前用户对创建集群实例操作未授权，请添加CAM权限 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId，没有找到对应资源。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound.CAMInfoNotFound | CAM资源未找到。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| UnsupportedOperation.InstanceTypeError | 不支持该操作，服务类型有误。 |
| UnsupportedOperation.StatusNotSupport | 不支持该操作，实例状态有误。 |
文档反馈