CreateIndex - 创建索引信息

更新时间: 2023-09-22 14:30:58

创建索引信息。

接口说明

方法

POST

URI

/openapi/ha3/instances/{instanceId}/indexes

调试

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

调试

授权信息

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

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

请求语法

POST /openapi/ha3/instances/{instanceId}/indexes

请求参数

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

实例ID

ha-cn-2r42ppr7901
bodyobject

请求体参数

namestring

索引名称

ha-cn-zvp2qr1sk01_qrs
dataSourcestring

数据来源(可忽略):odps、mns、flink、streaming

test1
domainstring

数据源机房

vpc_hz_domain_1
contentstring

内容

{\"summarys\":{\"summary_fields\":[\"id\"]},\"indexs\":[{\"index_name\":\"index_id\",\"index_type\":\"PRIMARYKEY64\",\"index_fields\":\"id\",\"has_primary_key_attribute\":true,\"is_primary_key_sorted\":false}],\"attributes\":[\"id\"],\"fields\":[{\"field_name\":\"id\",\"field_type\":\"UINT16\"}],\"table_name\":\"index_2\"}
partitioninteger

数据分区

2
dataSourceInfoobject

数据源相关信息 (向量检索版新版本必填)

processPartitionCountinteger

数据更新资源数

4
typestring

数据源类型 odps swift saro oss

odps
configobject

odps相关

endpointstring

odps数据源的endpoint, oss数据源的endpoint

https://oss-cn-hangzhou.aliyuncs.com
accessKeystring

odps数据源ak

L***p
accessSecretstring

odps数据源ak secret

5**9a6
projectstring

odps数据源项目名称

bbt_algo_pai
partitionstring

数据源为odps时必填

ds=20230114
tablestring

表名称

bbt_rec_swing_u2i2i_score_be_v1
autoBuildIndexboolean

是否开启自动全量

true
extendobject

字段配置的扩展的内容 key: 向量字段(vector)、 需embeding字段(embeding)

dryRunboolean

是否dryRun创建(仅校验数据源是否合法)。取值:-true 是 -false 否

true

###请求示例

POST /openapi/ha3/instances/ose-test1/indexes
{

    "name": "aaa",

    "dataSource": "beixuan_test",

    "domain": "test",   // 数据源的部署名称

    "content": "",

    "partition": 2

}

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

id of request

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

索引信息

{}

返回示例

正确返回

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

详情可参考响应结构

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:dryRun
2022-01-12新增 OpenAPI看变更集
阿里云首页 智能开放搜索 OpenSearch 相关技术圈