調用ListDateSourceGenerations擷取資料來源歷史迴流資訊-智能OpenSearch OpenSearch-阿里雲

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations?domainName={domainName}

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListDateSourceGenerations

list

*Instance

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

無

請求文法

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

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 id。	ha-cn-pl32rf0****
dataSourceName	string	是	資料來源名稱。	ha-cn-pl32rf0****_test_api

請求參數

名稱	類型	必填	描述	樣本值
validStatus	boolean	否	有效狀態（預設為 true） true 返回 Task 執行完成且未到期的 generation false 返回所有 generation	true
domainName	string	是	資料來源部署機房	bj_vpc_domain_1

請求樣本

GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/generations??domainName=pre_domain_1

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID。	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	返回結果
	array<object>	返回結果
generation	integer	索引全量版本	1626143930
createTime	integer	build index 開始時間	1626143673
status	string	狀態	STOPPED
buildDeployId	integer	離線部署 id	122
partition	object	Key 索引名稱 value 分區數量
	integer	分區數	1
timestamp	integer	增量時間戳記	1626143673
dataDumpRoot	string	dump 表索引檔案儲存體地址	hdfs://opensearch/dump.json

返回樣本

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "generationId":1626143930,
      "timestamp":16261436737,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    },{
      "generationId":1626143930,
      "timestamp":16261435453,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    }
  ]
}

樣本

正常返回樣本

JSON格式

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "generation": 1626143930,
      "createTime": 1626143673,
      "status": "STOPPED",
      "buildDeployId": 122,
      "partition": {
        "key": 1
      },
      "timestamp": 1626143673,
      "dataDumpRoot": "hdfs://opensearch/dump.json"
    }
  ]
}

錯誤碼

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

變更歷史

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