触发索引重建。
接口说明
方法
POST
URI
/openapi/ha3/instances/{instanceId}/actions/build-index
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
searchengine:BuildIndex |
update |
*Instance
|
无 | 无 |
请求语法
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 |
返回结果 |
{} |
示例
正常返回示例
JSON
格式
{
"requestId": "407BFD91-DE7D-50BA-8F88-CDE52A3B5E46",
"result": {}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。