全部产品
Search
文档中心

智能开放搜索 OpenSearch:BuildIndex - 触发索引重建

更新时间:Oct 16, 2024

触发索引重建。

接口说明

方法

POST

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:BuildIndexupdate
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-pl32rf0****
bodyobject

一个 JSON 格式的字符串,完整 JSON 字符串信息,具体内容参见以下详细信息。

dataSourceNamestring

数据源名称

ha-cn-pl32rf0****_test_api
domainstring

数据源机房

sz_vpc_domain_1
dataSourceTypestring

数据源类型

odps
partitionstring

数据源为 odps 时必填

ds=20201010
dataTimeSecinteger

int 类型,秒级时间戳,数据源为 API 推送时必填

1640867288
buildModestring

重建 index 方式: api、indexRecover

api
generationlong

历史回流 ID

160131146

请求示例



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

requestIdstring

请求 ID

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

返回结果

{}

返回示例

正确返回 

{

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

  "result": []

}

详情可参考响应结构

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI查看变更详情