調用GetInstance介面擷取執行個體詳情-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

透過指定的執行個體 ID 查看執行個體詳情。

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:GetInstance

get

*Instance

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

無

請求文法

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

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	ha-cn-pl32rf0****

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

請求範例

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

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
result	object	傳回結果。
description	string	執行個體描述。	test
resourceGroupId	string	資源群組 ID。	rg-aekzjvw24****
expiredTime	string	到期時間，格式為 YYYY-MM-DD HH:mm:ss.S。	024-05-21 16:49:31.0
commodityCode	string	商品 code。	opensearch_ha3post_public_cn
instanceId	string	資源一級 ID。	ha-cn-pl32rf0****
createTime	string	建立時間。	2022-06-17T02:01:26Z
lockMode	string	鎖定狀態。	Unlock
chargeType	string	付費類型。	POSYPAY
updateTime	string	更新時間，格式為 YYYY-MM-DD HH:mm:ss.S。	024-05-21 16:49:31.0
inDebt	boolean	是否欠費。	false
status	string	執行個體狀態階段。 INIT：初始化 WAIT_CONFIG：待配置 CONFIG_UPDATING：配置生效中 READY：正常	INIT
tags	array<object>	標籤。
	object	標籤。
key	string	標籤鍵。	opensearch
value	string	標籤值。	opensearch
edition	string	執行個體版本 -vector：向量檢索版 -engine：召回引擎版。	vector
userName	string	使用者名稱。	admin
version	string	引擎版本。	ha3_3.10.0
bsVersion	string	bs 版本。	bs_3.13.2
noQrs	boolean	是否為單節點執行個體。	false
newMode	boolean	是否為新版本主控台頁面。	true
network	object	網路搜尋引擎執行個體資訊。
vSwitchId	string	虛擬交換器 ID。	vsw-bp11ldcf59q2n****
vpcId	string	VPC 網路 ID。	vpc-wz9axk41d9vff****
endpoint	string	閘道器接入點。	ha-cn-35t3r****.ha.aliyuncs.com
publicEndpoint	string	公網網域。	ha-cn-35t3ni****.public.ha.aliyuncs.com
allow	string	公網網域白名單。	127.0.0.1
spec	object	節點規格。
qrsResource	object	查詢節點規格。
category	string	機型 -local_ssd：本地 SSD 磁碟型 -cloud：雲端硬碟型。	local_ssd
cpu	integer	CPU 核心數。	2
mem	integer	記憶體，單位：G。	10
disk	integer	節點儲存空間大小，單位：GB。	100
nodeCount	integer	節點數量。	1
searchResource	object	資料節點規格。
category	string	機型 -local_ssd：本地 SSD 磁碟型 -cloud：雲端硬碟型。	local_ssd
cpu	integer	CPU 核心數。	2
mem	integer	記憶體，單位：G。	10
disk	integer	節點儲存空間大小，單位：GB。	100
nodeCount	integer	節點數量。	1
zoneCount	integer	可用區數量。	1
requestId	string	請求 ID。	E7B7D598-B080-5C8E-AA35-D43EC0D5F886

傳回範例

正常傳回範例

{
    "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"
}

異常傳回範例

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

樣本

正常返回樣本

JSON格式

{
  "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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。