Call GetClusterRunTimeInfo to query cluster runtime information - OpenSearch

Queries the runtime information about a specified cluster.

Operation description

Method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:GetClusterRunTimeInfo

get

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample requests

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

Response elements

Element	Type	Description	Example
	object	The results returned.
requestId	string	The request ID.	E45380E8-994A-5402-9806-F114B3295FCF
result	array<object>	The result.
	array<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.	vpc_hz_domain_1
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.
	object
configUpdateTime	string	The time when the configuration was last updated.	2024-05-21 16:05:26
name	string	The cluster name.	vpc_hz_domain_1
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.
	array<object>	The information about the cluster node.
dataStatusList	array<object>	The data of the Searcher worker.
	array<object>
docSize	integer	The storage capacity. Unit: GB.	2
fullVersion	integer	The time when the full index version was generated.	1718846192
incVersion	integer	The time when the incremental index version was generated.	1718846192
incUpdateTime	string	The time when incremental data in the index was last updated.	2024-05-21 16:05:26
fullUpdateTime	string	The time when full data in the index was last updated.	2024-05-21 16:05:26
indexConfigInfo	object	The information about the index configuration.
configMetaName	string	The name of the index configuration.	index_meta_name
version	integer	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	integer	The version number.	1.0
lackMemWorker	array	The name of the worker that failed due to insufficient memory.
	string	The name of the failed worker.	test-fail-worker
deployFailedWorker	array	The name of the worker that failed due to a deployment failure.
	string	The name of the failed worker.	test-fail-worker
lackDiskWorker	array	The name of the worker that failed due to insufficient disks.
	string	The name of the failed worker.	test-fail-worker
errorMsg	string	The error message.	0A3B1C48006A6C0905F6375F4821EB50
indexSize	integer	The index size.	100
name	string	The name of the QRS worker.	ha-cn-pl32rf0****_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-pl32rf0****_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.
	object	The response body.
configUpdateTime	string	The time when the configuration was last updated.	2024-05-21 16:05:26
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

ResponseExample

Correct response

{
  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
  "result": [
    {
      "clusterName": "",
      "queryNode": {
        "serviceStatus": {
          "name": "service_name",
          "totalSize": 1,
          "doneSize": 1,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "name": "default",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100,
            "configUpdateTime": ""
          }
        ]
      },
      "dataNodes": [
        {
          "serviceStatus": {
            "name": "service_name",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "name": "default",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "configUpdateTime": ""
            }
          ],
          "dataStatusList": [
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            },
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            }
          ]
        }
      ]
    }
  ]
}

Examples

Success response

JSON format

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": [
    {
      "clusterName": "vpc_hz_domain_1",
      "queryNode": {
        "serviceStatus": {
          "name": "vpc_hz_domain_1\n",
          "totalSize": 100,
          "doneSize": 100,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "configUpdateTime": "2024-05-21 16:05:26",
            "name": "vpc_hz_domain_1\n",
            "totalSize": 6,
            "doneSize": 100,
            "donePercent": 100
          }
        ]
      },
      "dataNodes": [
        {
          "dataStatusList": [
            {
              "docSize": 2,
              "fullVersion": 1718846192,
              "incVersion": 1718846192,
              "incUpdateTime": "2024-05-21 16:05:26",
              "fullUpdateTime": "2024-05-21 16:05:26",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 0
              },
              "advanceConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 1
              },
              "lackMemWorker": [
                "test-fail-worker\n"
              ],
              "deployFailedWorker": [
                "test-fail-worker\n"
              ],
              "lackDiskWorker": [
                "test-fail-worker"
              ],
              "errorMsg": "0A3B1C48006A6C0905F6375F4821EB50",
              "indexSize": 100,
              "name": "ha-cn-pl32rf0****_qrs",
              "totalSize": 1,
              "doneSize": 100,
              "donePercent": 100
            }
          ],
          "serviceStatus": {
            "name": "ha-cn-pl32rf0****_qrs",
            "totalSize": 100,
            "doneSize": 100,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "configUpdateTime": "2024-05-21 16:05:26",
              "name": "test_0704",
              "totalSize": 0,
              "doneSize": 1,
              "donePercent": 100
            }
          ]
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.