調用ListInstances API擷取執行個體列表-智能OpenSearch OpenSearch-阿里雲

擷取執行個體列表。

介面說明

方法

GET

URI

/openapi/ha3/instances

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListInstances

get

*Instance

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

無

請求文法

GET /openapi/ha3/instances HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
pageNumber	integer	否	指定頁碼，預設為：1	1
pageSize	integer	否	指定每頁展示條數，預設為 10，限制:[1-50]	10
instanceId	string	否	執行個體 id	ha-cn-pl32rf0****
description	string	否	通過執行個體描述稱進行過濾，支援模糊比對。	searchengine instance
resourceGroupId	string	否	資源群組 id。	rg-aekzgpiswzbksdi
edition	string	否	執行個體類型，vector(向量索引版)，engine(召回引擎版)	vector
tags	array<object>	否	標籤。
	object	否	執行個體標籤。
key	string	否	標籤鍵	opensearch
value	string	否	標籤值	opensearch
catalog	string	否
database	string	否
table	string	否
dataSourceType	string	否

參數	類型	是否必需	描述
status	String	否	通過執行個體狀態進行過濾。Running, Ready, Initializing,Starting
expiredTime	Long	否	秒級時間戳記，通過到期時間過濾，大於目前時間會過濾出即將到期的執行個體（不包含已經到期的執行個體）

樣本

請求樣本

GET /openapi/ha3/instances?name=test&instanceId=abc&page=1&size=10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
result	array<object>	返回結果
	array<object>	InstanceItemType
description	string	執行個體描述	test
resourceGroupId	string	資源群組 ID	ha-cn-pl32rf0****
expiredTime	string	到期時間	1634885083
commodityCode	string	商品 code	opensearch_ha3post_public_cn
status	string	狀態	READY
instanceId	string	資源一級 ID	ha-cn-pl32rf0****
createTime	string	建立時間	2022-06-04T02:03:21Z
lockMode	string	鎖定狀態	Unlock
chargeType	string	付費類型	POSTPAY
updateTime	string	更新時間	2018-12-06T11:17:49.0
inDebt	boolean	是否欠費	false
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
tags	array<object>	標籤。
	object	標籤。
key	string	標籤鍵	opensearch
value	string	標籤值	opensearch
edition	string	執行個體版本 -vector: 向量檢索版 -engine:召回引擎版	vector
userName	string	使用者名稱	admin
version	string	引擎版本號碼	ha3_3.10.0
noQrs	boolean	是否是單節點執行個體	false
spec	object	節點規格
qrsResource	object	查詢節點規格
category	string	機型 -local_ssd:本地 SSD 盤型 -cloud: 雲端硬碟型	local_ssd
cpu	integer	CPU 核心數。	1
mem	integer	記憶體，單位：G。	10
disk	integer	節點儲存空間大小，單位：GB。	100
nodeCount	integer	節點數量	3
searchResource	object	資料節點規格
category	string	機型 -local_ssd:本地 SSD 盤型 -cloud: 雲端硬碟型	local_ssd
cpu	integer	CPU 核心數。	1
mem	integer	記憶體，單位：G。	10
disk	integer	節點儲存空間大小，單位：GB。	100
nodeCount	integer	節點數量	3
dataSourceDetails	array<object>
	array<object>
indexName	string
type	string
config	object
endpoint	string
accessKey	string
project	string
partition	string
table	string
namespace	string
path	string
ossPath	string
bucket	string
catalog	string
database	string
tag	string
totalCount	integer	總記錄數。	5
requestId	string	請求 ID	89B968E6-1E41-58DF-BB25-5F98ECC759CE

返回樣本

正常返回樣本

{
    "result":
    [
        {
            "inDebt": false,
            "lockMode": "Unlock",
            "trFreeUrl": "",
            "chargeType": "POSTPAY",
            "edition": "engine",
            "description": "test",
            "updateTime": "2024-05-06 14:08:24.0",
            "userName": "admin",
            "version": "ha3_3.10.0",
            "spec":
            {
                "qrsResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 8,
                    "disk": 100,
                    "nodeCount": 5
                },
                "searchResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 16,
                    "disk": 100,
                    "nodeCount": 4
                }
            },
            "network":
            {
                "vSwitchId": "vsw-bp179zkffzyva26ua8xil",
                "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
                "endpoint": "ha-cn-35t3ni61z06.ha.aliyuncs.com",
                "publicEndpoint": "ha-cn-35t3ni61z06.public.ha.aliyuncs.com",
                "allow": "127.0.0.1"
            },
            "tags":
            [
                {
                    "value": "rg-acfmv2hk2jpsxia",
                    "key": "acs:rm:rgId"
                }
            ],
            "noQrs": false,
            "instanceId": "ha-cn-35t3ni61z06",
            "createTime": "2024-03-14 10:49:32.0",
            "commodityCode": "opensearch_ha3post_public_cn",
            "resourceGroupId": "rg-acfmv2hk2jpsxia",
            "status": "READY"
        }
    ],
    "requestId": "949FDF5E-6FF6-13B9-A196-59B25F143B7F",
    "totalCount": 1
}

異常返回樣本

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

樣本

正常返回樣本

JSON格式

{
  "result": [
    {
      "description": "test",
      "resourceGroupId": "ha-cn-pl32rf0****",
      "expiredTime": "1634885083",
      "commodityCode": "opensearch_ha3post_public_cn",
      "status": "READY",
      "instanceId": "ha-cn-pl32rf0****",
      "createTime": "2022-06-04T02:03:21Z",
      "lockMode": "Unlock",
      "chargeType": "POSTPAY",
      "updateTime": "2018-12-06T11:17:49.0",
      "inDebt": false,
      "network": {
        "vSwitchId": "vsw-bp11ldcf59q2n****",
        "vpcId": "vpc-wz9axk41d9vff****",
        "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com",
        "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com",
        "allow": "127.0.0.1"
      },
      "tags": [
        {
          "key": "opensearch",
          "value": "opensearch"
        }
      ],
      "edition": "vector",
      "userName": "admin",
      "version": "ha3_3.10.0",
      "noQrs": false,
      "spec": {
        "qrsResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        },
        "searchResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        }
      },
      "dataSourceDetails": [
        {
          "indexName": "",
          "type": "",
          "config": {
            "endpoint": "",
            "accessKey": "",
            "project": "",
            "partition": "",
            "table": "",
            "namespace": "",
            "path": "",
            "ossPath": "",
            "bucket": "",
            "catalog": "",
            "database": "",
            "tag": ""
          }
        }
      ]
    }
  ],
  "totalCount": 5,
  "requestId": "89B968E6-1E41-58DF-BB25-5F98ECC759CE"
}

錯誤碼

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

變更歷史

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