触发索引重建。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
searchengine:BuildIndex | update |
|
| 无 |
请求语法
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 | long | 否 | 历史回流 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 推送时必填
}
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "407BFD91-DE7D-50BA-8F88-CDE52A3B5E46",
"result": {}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-01-12 | 新增 OpenAPI | 查看变更详情 |