Domain name for API request: es.intl.tencentcloudapi.com.
Query view data of a cluster, including cluster-level, node, and Kibana dimensions.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeViews. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Cluster instance ID. |
| Parameter Name | Type | Description |
|---|---|---|
| ClusterView | ClusterView | Cluster dimension view |
| NodesView | Array of NodeView | Node dimension view |
| KibanasView | Array of KibanaView | Kibana dimensional view |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query the cluster view
https://es.intl.tencentcloudapi.com/?Action=DescribeViews
&InstanceId=es-xxxxxxxx
&<Common request parameters>{
"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
}
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure.UnAuthCreateInstance | Current user is unauthorized for the create cluster instance operation. Add CAM permission. |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId. No corresponding resources were found. |
| ResourceInUse | The resource is occupied. |
| ResourceNotFound.CAMInfoNotFound | CAM resource is not found. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
| UnsupportedOperation.InstanceTypeError | This operation is not supported. The service type is incorrect. |
| UnsupportedOperation.StatusNotSupport | This operation is not supported. The instance status is incorrect. |
피드백