ListInstanceSpecs - OpenSearch - Alibaba Cloud Documentation Center

Queries the specifications of an instance.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/specs?type=qrs

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /openapi/ha3/instances/{instanceId}/specs

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-2r42ostoc01
type	string	Yes	The node type. Valid values: qrs: Query Result Searcher (QRS) Worker search: Searcher Worker index: index node cluster: cluster	search

Sample requests

GET /openapi/ha3/instances/ha3_instance_name/specs

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	10D5E615-69F7-5F49-B850-00169ADE513C
result	array<object>	The instance types.
	object	A list of instance specifications
cpu	integer	The number of vCPUs.	1
mem	integer	The memory of the instance. Unit: GB.	4
minDisk	integer	The minimum storage of a single data node. Unit: GB.	100
maxDisk	integer	The maximum storage of a single data node. Unit: GB.	600

Sample responses

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "cpu": 1
      "mem": 2,
      "disk": 100
    },
    {
      "cpu": 2
      "mem": 4,
      "disk": 100      
    }    
  ]
}

Examples

Sample success responses

JSONformat

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "cpu": 1,
      "mem": 4,
      "minDisk": 100,
      "maxDisk": 600
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-03-28	The response structure of the API has changed	View Change Details