GetClusterRunTimeInfo - OpenSearch - Alibaba Cloud Documentation Center

Queries the runtime information about a specified cluster.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/cluster-run-time-info

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:GetClusterRunTimeInfo	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

GET /openapi/ha3/instances/{instanceId}/cluster-run-time-info HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-2r42ncw4102

Sample requests

GET /openapi/ha3/instances/ose-test1/cluster-run-time-info

Response parameters

Parameter	Type	Description	Example
	object	The results returned.
requestId	string	The request ID.	E45380E8-994A-5402-9806-F114B3295FCF
result	array<object>	The result.
result	object	The runtime information of the cluster.
clusterName	string	The cluster name.	vpc_hz_domain_1
queryNode	object	The information about the Query Result Searcher (QRS) workers.
serviceStatus	object	The service status of the QRS worker.
name	string	The cluster name.	ha-cn-c4d2rq7nt04_qrs
totalSize	integer	The total number of QRS workers in the cluster.	100
doneSize	integer	The number of processed QRS workers in the cluster.	100
donePercent	integer	The process progress of QRS workers in the cluster. Unit: percentage.	100
configStatusList	array<object>	The configuration status.
configStatusList	object
configUpdateTime	string	The time when the configuration was last updated.	" "
name	string	The cluster name.	ha-cn-zvp2qr1sk01_qrs
totalSize	integer	The total number of QRS workers in the cluster.	6
doneSize	integer	The number of processed QRS workers in the cluster.	100
donePercent	integer	The process progress of QRS workers in the cluster. Unit: percentage.	100
dataNodes	array<object>	The information about the Searcher workers.
dataNodes	object	The information about the cluster node.
dataStatusList	array<object>	The data of the Searcher worker.
dataStatusList	object
docSize	integer	The storage capacity. Unit: GB.	2
fullVersion	long	The time when the full index version was generated.	123423
incVersion	long	The time when the incremental index version was generated.	123423
incUpdateTime	string	The time when incremental data in the index was last updated.	""
fullUpdateTime	string	The time when full data in the index was last updated.	" "
indexConfigInfo	object	The information about the index configuration.
configMetaName	string	The name of the index configuration.	index_meta_name
version	long	The version of the index template.	1.0.0
advanceConfigInfo	object	The information about the advanced configuration.
configMetaName	string	The name of the index configuration.	index_meta_name
version	long	The version number.	1.0
lackMemWorker	array	The name of the worker that failed due to insufficient memory.
lackMemWorker	string	The name of the failed worker.	""
deployFailedWorker	array	The name of the worker that failed due to a deployment failure.
deployFailedWorker	string	The name of the failed worker.	""
lackDiskWorker	array	The name of the worker that failed due to insufficient disks.
lackDiskWorker	string	The name of the failed worker.	""
errorMsg	string	The error message.	0A3B1C48006A6C0905F6375F4821EB50
indexSize	long	The index size.	100
name	string	The name of the QRS worker.	ha-cn-c4d2rq7nt04_qrs
totalSize	integer	The total number of QRS workers in the cluster.	1
doneSize	integer	The number of processed QRS workers in the cluster.	100
donePercent	integer	The configuration progress. Unit: percentage.	100
serviceStatus	object	The service status of the QRS worker.
name	string	The name of the QRS worker.	ha-cn-0ju2s170b03_qrs
totalSize	integer	The total number of QRS workers in the cluster.	100
doneSize	integer	The number of processed QRS workers in the cluster.	100
donePercent	integer	The process progress of QRS workers in the cluster. Unit: percentage.	100
configStatusList	array<object>	The configuration status.
configStatusList	object	The response body.
configUpdateTime	string	The time when the configuration was last updated.	""
name	string	The cluster name.	test_0704
totalSize	integer	The total number of Searcher workers in the cluster.	0
doneSize	integer	The number of processed Searcher workers in the cluster.	1
donePercent	integer	The configuration progress. Unit: percentage.	100

Examples

Sample success responses

JSONformat

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": [
    {
      "clusterName": "vpc_hz_domain_1",
      "queryNode": {
        "serviceStatus": {
          "name": "ha-cn-c4d2rq7nt04_qrs",
          "totalSize": 100,
          "doneSize": 100,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "configUpdateTime": "\" \"",
            "name": "ha-cn-zvp2qr1sk01_qrs",
            "totalSize": 6,
            "doneSize": 100,
            "donePercent": 100
          }
        ]
      },
      "dataNodes": [
        {
          "dataStatusList": [
            {
              "docSize": 2,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "\"\"",
              "fullUpdateTime": "\" \"",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 0
              },
              "advanceConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 1
              },
              "lackMemWorker": [
                "\"\""
              ],
              "deployFailedWorker": [
                "\"\""
              ],
              "lackDiskWorker": [
                "\"\""
              ],
              "errorMsg": "0A3B1C48006A6C0905F6375F4821EB50",
              "indexSize": 100,
              "name": "ha-cn-c4d2rq7nt04_qrs",
              "totalSize": 1,
              "doneSize": 100,
              "donePercent": 100
            }
          ],
          "serviceStatus": {
            "name": "ha-cn-0ju2s170b03_qrs",
            "totalSize": 100,
            "doneSize": 100,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "configUpdateTime": "\"\"",
              "name": "test_0704",
              "totalSize": 0,
              "doneSize": 1,
              "donePercent": 100
            }
          ]
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details