使用ListAdvanceConfigs API擷取進階配置列表-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

獲取進階設定清單。

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs?type=online

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListAdvanceConfigs

list

*Instance

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

無

請求文法

GET /openapi/ha3/instances/{instanceId}/advanced-configs HTTP/1.1

路徑參數

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

請求參數

名稱	類型	必填	描述	樣本值
type	string	否	進階設定類型： - online - offline（預設）。	online
dataSourceName	string	否	資料來源名稱。	ha-cn-pl32rf0****_test_api
indexName	string	否	索引名稱。	test_api
newMode	boolean	否	是否為新版本主控台頁面。	true
pageNumber	string	否	指定頁碼，預設為：1。	1
pageSize	string	否	指定每頁顯示筆數，預設為 10。	10

請求範例

GET /openapi/ha3/instances/ose-test1/advanced-configs

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID。	4FB0325E-8C37-5525-96AC-0333523170A3
result	array<object>	傳回結果。
	array<object>	進階設定清單。
updateTime	integer	更新時間，Unix 時間戳記，單位為毫秒。	1631070464000
desc	string	描述。	Custom Description
files	array<object>	檔案名稱清單。
	object	檔案資訊。
name	string	檔案名稱。	file_name_1
fullPathName	string	絕對路徑。	/path/wpd/nae
isDir	boolean	是否為目錄。取值：-true：是-false：否。	true
isTemplate	boolean	是否為範本。取值：-true：是-false：否。	true
content	string	設定內容 http，git 請求時不為空。	{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}
contentType	string	設定內容的類型（FILE, GIT, HTTP, ODPS）。	FILE
name	string	進階設定名稱。	my_index
status	string	進階設定狀態 drafting: 草稿 used: 使用中 unused: 未使用 trash: 刪除中。	drafting
creator	string	建立者 userid。	123456
advanceConfigType	string	-ONLINE: 線上設定, -ONLINE_CAVA: 線上 cava 設定, -ONLINE_PLUGIN: 線上外掛程式, -ONLINE_QUERY: 查詢設定, -OFFLINE_DICT: 離線設定, -OFFLINE_TABLE: 離線資料表, -OFFLINE_COMMON: 離線設定, -OFFLINE_PLUGIN: 離線外掛程式, -OFFLINE_INDEX: 索引設定。	ONLINE

傳回範例。

正確傳回

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "name": "my_index",
      "status": "drafting",
      "updateTime": 1631070464000,
      "desc":"test",
      "files":[
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ]
    },
    {
      "name": "my_index2",
      "status": "drafting",
      "updateTime": 1631070464000,
      "desc":"test",
      "files":[
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ]
    }
  ]
}

樣本

正常返回樣本

JSON格式

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": [
    {
      "updateTime": 1631070464000,
      "desc": "Custom Description",
      "files": [
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ],
      "content": "{\\\"url\\\":\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\"}",
      "contentType": "FILE",
      "name": "my_index",
      "status": "drafting",
      "creator": "123456",
      "advanceConfigType": "ONLINE"
    }
  ]
}

錯誤碼

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

變更歷史

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