CreateSearchIndex

调用CreateSearchIndex接口创建一个多元索引。

说明

关于多元索引的更多信息,请参见多元索引介绍

注意事项

创建多元索引前,请确保数据表的最大版本数为1,数据生命周期满足如下条件中的任意一个。

  • 数据表的数据生命周期为-1(数据永不过期)。

  • 数据表的数据生命周期不为-1时,数据表为禁止更新状态(即是否允许更新)。

请求消息结构

message CreateSearchIndexRequest {
    required string table_name = 1;
    required string index_name = 2;
    optional IndexSchema schema = 3;
    optional string source_index_name = 4;
    optional int32 time_to_live = 5; // unit is seconds
}

名称

类型

是否必选

描述

table_name

string

数据表名称。

index_name

string

多元索引名称。

schema

IndexSchema

多元索引Schema。

source_index_name

string

源多元索引名称。只有当使用动态修改schema时才需要设置此参数。

time_to_live

int32

多元索引生命周期,即数据的保存时间。默认值为-1。单位为秒。

当数据的保存时间超过设置的数据生命周期时,系统会自动清理超过数据生命周期的数据。

数据生命周期至少为86400秒(一天)或-1(数据永不过期)。

关于多元索引生命周期的更多信息,请参见生命周期管理

响应消息结构

message CreateSearchIndexResponse {
}

您需要通过判断HTTP请求的status取值是否为200来确定是否执行成功。

  • 如果status取值为200,则表示执行成功。

  • 如果status取值为400或者500,则表示执行失败。

    如果请求执行失败时,则会返回Error信息。更多信息,请参见Error

使用SDK

您可以使用如下语言的SDK创建多元索引。