調用ListTables API擷取索引列表-智能OpenSearch OpenSearch-阿里雲

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/tables

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListTables

list

*Instance

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

無

請求文法

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

路徑參數

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

請求參數

名稱	類型	必填	描述	樣本值
newMode	boolean	否	是否為新版本控制台頁面	true

請求樣本

GET /openapi/ha3/instances/{instanceId}/tables

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID。	10D5E615-69F7-5F49-B850-00169ADE513C
result	array<object>	返回結果
	object	返回結果
name	string	索引名	es_test_1b
indexStatus	string	索引表狀態 (NEW, PUBLISH, IN_USE: 召回引擎版建立成功後為正常狀態, NOT_USE, STOP_USE, RESTORE_USE, FAIL: 向量檢索版新版本首次建立索引失敗狀態)	IN_USE
status	string	索引表狀態 (NEW, PUBLISH, IN_USE: 召回引擎版建立成功後為正常狀態, NOT_USE, STOP_USE, RESTORE_USE, FAIL: 向量檢索版新版本首次建立索引失敗狀態)	IN_USE

樣本

正常返回樣本

JSON格式

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "name": "es_test_1b",
      "indexStatus": "IN_USE",
      "status": "IN_USE"
    }
  ]
}

錯誤碼

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

變更歷史

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