CreateIndex - 创建索引信息

创建索引信息。

接口说明

方法

POST

URI

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

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

###请求示例

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": {
    "test": "test",
    "test2": 1
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI
阿里云首页 智能开放搜索 OpenSearch 相关技术圈