全部產品
Search
文件中心

OpenSearch:BuildIndex - 觸發索引重建

更新時間:Sep 22, 2025

觸發索引重建。

介面說明

方法

POST

URI

/openapi/ha3/instances/{instanceId}/actions/build-index

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:BuildIndex

update

*Instance

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

請求文法

POST /openapi/ha3/instances/{instanceId}/actions/build-index HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

instanceId

string

執行個體 ID

ha-cn-pl32rf0****

body

object

一個 JSON 格式的字串,完整 JSON 字串資訊,具體內容參見以下詳細資料。

{}

dataSourceName

string

資料來源名稱

ha-cn-pl32rf0****_test_api

domain

string

資料來源機房

sz_vpc_domain_1

dataSourceType

string

資料來源類型

odps

partition

string

資料來源為 odps 時必填

ds=20201010

dataTimeSec

integer

int 類型,秒級時間戳記,資料來源為 API 推送時必填

1640867288

buildMode

string

重建 index 方式: api、indexRecover

api

generation

integer

歷史迴流 ID

160131146

tag

string

dlf 資料來源-tag

test

path

string

相對路徑

/test/dir

請求樣本



POST /openapi/ha3/instances/ha3_instance_name/actions/build-index


​ 

 {

    "dataSourceName": "my_data_source",

    "domain": "test", //資料來源部署

    "indexes": [

      "index1",

      "index2"

    ],

    "dataSourceType": "odps", //odps 或 swift,必填

    "partition": "20201010", //資料來源為 odps 時必填

    "dataTimeSec": 1640867288 //int 類型,秒級時間戳記,資料來源為 api 推送時必填

  }

 ​  ​ 

{

    "dataSourceName": "my_data_source",

    "domain": "test", //資料來源部署

    "indexes": [

      "index1",

      "index2"

    ],

    "dataSourceType": "swift", //odps 或 swift,必填

    "partition": "20201010", //資料來源為 odps 時必填

    "dataTimeSec": 1640867288 //int 類型,秒級時間戳記,資料來源為 api 推送時必填

  }

 ​

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

requestId

string

請求 ID

407BFD91-DE7D-50BA-8F88-CDE52A3B5E46

result

object

返回結果

{}

返回樣本

正確返回 

{

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": []

}

詳情可參考響應結構

樣本

正常返回樣本

JSON格式

{
  "requestId": "407BFD91-DE7D-50BA-8F88-CDE52A3B5E46",
  "result": {}
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情