GetInstance - OpenSearch - Alibaba Cloud Documentation Center

Queries the details of an instance based on the instance ID.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}

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}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-7pp2pcna701

Sample requests

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
result	object	The results returned.
description	string	The description of the instance.	ha3_test
resourceGroupId	string	The ID of the resource group.	rg-aekzjvw24el5lma
expiredTime	string	The time when the instance expires.	1634609702
commodityCode	string	The commodity code of the instance.	commodityCode
instanceId	string	The instance ID.	ha-cn-7mz2qsgq301
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 updated.	1634609702
inDebt	boolean	Indicates whether an overdue payment is involved.	false
status	string	The status of the instance. Valid values: INIT: being initialized WAIT_CONFIG: to be configured CONFIG_UPDATING: configuration taking effect READY: normal	INIT
tags	array<object>	The tags of the instance.
	object
key	string	The tag key.	env
value	string	The tag value.	prod
requestId	string	The ID of the request.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886

Sample responses

Sample success responses

{
  "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "result": 
  {
    "instanceId":"fadsfsafs",
    "inDebt":true,
    "lockMode":"Unlock",
    "expiredTime":"asdfas",
    "updateTime":"dfasf",
    "createTime":"dfasf",
    "resourceGroupId":"resourceGroupID",
    "commodityCode":"commodityCode",
    "chargeType":"POSYPAY",
    "description":"this is description",
    "apiVersion": "tisplus/v1",
    "network": {
      "vSwitchId": "vswitch_id_xxx",
      "vpcId": "vpc_id_xxx",	  
    },
    "userName": "user",
    "spec": {
      "searchResource": {
        "disk": 50,
        "mem": 8,
        "cpu": 2,
        "nodeCount": 2
      },
      "qrsResource": {
        "disk": 50,
        "mem": 8,
        "cpu": 2,
        "nodeCount": 2
      }
    },
   "status": "INIT",
  }
}

Sample error responses

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

Examples

Sample success responses

JSONformat

{
  "result": {
    "description": "ha3_test",
    "resourceGroupId": "rg-aekzjvw24el5lma",
    "expiredTime": "1634609702",
    "commodityCode": "commodityCode",
    "instanceId": "ha-cn-7mz2qsgq301",
    "createTime": "2022-06-17T02:01:26Z",
    "lockMode": "Unlock",
    "chargeType": "POSYPAY",
    "updateTime": "1634609702",
    "inDebt": false,
    "status": "INIT",
    "tags": [
      {
        "key": "env",
        "value": "prod"
      }
    ]
  },
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886"
}

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