GetInstance - OpenSearch - Alibaba Cloud Documentation Center

Retrieves the details of an instance by its ID.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}

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:GetInstance

get

*Instance

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

None

Request syntax

GET /openapi/ha3/instances/{instanceId} 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.

Request example

GET /openapi/ha3/instances/ha3-cn-xxxxxx

Response elements

Element	Type	Description	Example
	object	The response schema.
result	object	The returned result.
description	string	The description of the instance.	test
resourceGroupId	string	The resource group ID.	rg-aekzjvw24****
expiredTime	string	The expiration time.	024-05-21 16:49:31.0
commodityCode	string	The commodity code.	opensearch_ha3post_public_cn
instanceId	string	The instance ID.	ha-cn-pl32rf0****
createTime	string	The time when the instance was created.	2022-06-17T02:01:26Z
lockMode	string	The lock status.	Unlock
chargeType	string	The billing method.	POSYPAY
updateTime	string	The time when the instance was last updated.	024-05-21 16:49:31.0
inDebt	boolean	Indicates whether the payment for the instance is overdue.	false
status	string	The status of the instance. INIT: The instance is being initialized. WAIT_CONFIG: The instance is pending configuration. CONFIG_UPDATING: The configuration is being applied. READY: The instance is running.	INIT
tags	array<object>	The tags.
	object	The tag.
key	string	The tag key.	opensearch
value	string	The tag value.	opensearch
edition	string	The edition of the instance. Valid values: - vector: Vector Search Edition - engine: Recall Engine Edition	vector
userName	string	The username.	admin
version	string	The engine version number.	ha3_3.10.0
bsVersion	string	The BS version number.	bs_3.13.2
noQrs	boolean	Indicates whether the instance is a standalone instance.	false
newMode	boolean	Indicates whether the new version of the console is used.	true
network	object	The network information of the search engine instance.
vSwitchId	string	The ID of the virtual switch.	vsw-bp11ldcf59q2n****
vpcId	string	The ID of the VPC.	vpc-wz9axk41d9vff****
endpoint	string	The gateway endpoint.	ha-cn-35t3r****.ha.aliyuncs.com
publicEndpoint	string	The public domain name.	ha-cn-35t3ni****.public.ha.aliyuncs.com
allow	string	The whitelist for the public domain name.	127.0.0.1
spec	object	The node specifications.
qrsResource	object	The specifications of the query node.
category	string	The type of the instance. The value local_ssd indicates the local SSD type, and the value cloud indicates the disk type.	local_ssd
cpu	integer	The number of CPU cores.	2
mem	integer	The memory size in GB.	10
disk	integer	The storage space of the node in GB.	100
nodeCount	integer	The number of nodes.	1
searchResource	object	The specifications of the data node.
category	string	The machine type. Valid values:	local_ssd
cpu	integer	The number of CPU cores.	2
mem	integer	The memory size in GB.	10
disk	integer	The storage space of the node in GB.	100
nodeCount	integer	The number of nodes.	1
zoneCount	integer	The number of zones.	1
requestId	string	The request ID.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886

Response examples

Successful response example

{
    "result":
    {
        "inDebt": false,
        "lockMode": "Unlock",
        "trFreeUrl": "",
        "chargeType": "POSTPAY",
        "edition": "vector",
        "description": "ha-cn-vkl3rgrfc01",
        "updateTime": "2024-05-30 10:52:00.0",
        "userName": "admin",
        "version": "vector_service_1.2.2",
        "spec":
        {
            "qrsResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 8,
                "disk": 100,
                "nodeCount": 0
            },
            "searchResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 16,
                "disk": 100,
                "nodeCount": 1
            }
        },
        "network":
        {
            "vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",
            "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
            "endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"
        },
        "tags":
        [
            {
                "value": "rg-acfmv2hk2jpsxia",
                "key": "acs:rm:rgId"
            }
        ],
        "noQrs": true,
        "instanceId": "ha-cn-vkl3rgrfc01",
        "createTime": "2024-05-30 10:50:33.0",
        "commodityCode": "opensearch_ha3post_public_cn",
        "resourceGroupId": "rg-acfmv2hk2jpsxia",
        "newMode": true,
        "status": "READY"
    },
    "requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"
}

Error response example

{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}

Examples

Success response

JSON format

{
  "result": {
    "description": "test",
    "resourceGroupId": "rg-aekzjvw24****",
    "expiredTime": "024-05-21 16:49:31.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2022-06-17T02:01:26Z",
    "lockMode": "Unlock",
    "chargeType": "POSYPAY",
    "updateTime": "024-05-21 16:49:31.0",
    "inDebt": false,
    "status": "INIT",
    "tags": [
      {
        "key": "opensearch",
        "value": "opensearch"
      }
    ],
    "edition": "vector",
    "userName": "admin",
    "version": "ha3_3.10.0",
    "bsVersion": "bs_3.13.2",
    "noQrs": false,
    "newMode": true,
    "network": {
      "vSwitchId": "vsw-bp11ldcf59q2n****\n",
      "vpcId": "vpc-wz9axk41d9vff****\n",
      "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com\n",
      "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com\n",
      "allow": "127.0.0.1\n"
    },
    "spec": {
      "qrsResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      },
      "searchResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      }
    },
    "zoneCount": 1
  },
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.