調用ListDataSources擷取資料來源列表-智能OpenSearch OpenSearch-阿里雲

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListDataSources

list

*Instance

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

無

請求文法

GET /openapi/ha3/instances/{instanceId}/data-sources HTTP/1.1

路徑參數

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

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

請求樣本

GET /openapi/ha3/instances/ha3_instances_id/data-sources

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID	93A9E542-8CF8-5BA6-99AB-94C0FE520429
result	array<object>	返回參數
	object	資料來源資訊列表
name	string	資料來源名稱。	ha-cn-pl32rf0****_test_api
type	string	類型	odps
domain	string	離線部署	vpc_hz_domain_1
indexes	array	索引列表
	string	資料來源索引。	index1
lastFulTime	integer	上一次全量時間	1718787785
status	string	資料來源狀態：new: 建立中； publish: 正常； trash: 刪除中	new

返回樣本

正確返回

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "name": "data_source_name",
      "type": "odps",
      "domain": "test",  // 離線部署
      "indexes": [
        "index1",
        "index2"
      ],
      "partitions": [
        "ds=2020"
        "ds=2021"
      ],
      "lastFullTime": 1628502036000,
      "config":{
        "accessKey": "xxx",
        "accessSecret": "xxxs",
        "project":"xxxx",
        "table":"xxx",
        "partition":"xxxx"
      },
      "autoBuildIndex": true,
      "status": "new"	   // new: 建立中； publish: 正常； trash: 刪除中
    },
    {
      "name": "data_source_name",
      "type": "odps",
      "domain": "test",  // 離線部署      
      "indexes": [
        "index1",
        "index2"
      ],
      "partitions": [
        "ds=2020"
        "ds=2021"
      ],
      "lastFullTime": 1628502036000,
      "config":{
        "accessKey": "xxx",
        "accessSecret": "xxxs",
        "project":"xxxx",
        "table":"xxx",
        "partition":"xxxx"
      },
      "autoBuildIndex": true,
      "status": "new"   // new: 建立中； publish: 正常； trash: 刪除中
    }
  ]
}

樣本

正常返回樣本

JSON格式

{
  "requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": [
    {
      "name": "ha-cn-pl32rf0****_test_api",
      "type": "odps",
      "domain": "vpc_hz_domain_1",
      "indexes": [
        "index1"
      ],
      "lastFulTime": 1718787785,
      "status": "new"
    }
  ]
}

錯誤碼

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

變更歷史

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