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

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:ListInstanceSpecs	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request syntax

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

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.
item	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