CreateTable
创建索引表
服务地址:
华东1(杭州)
输入参数
只看必填
instanceId实例id
dryRun是否dryRun创建(仅校验数据源是否合法)
请选择布尔值
bodybody
name索引名
dataProcessorCount数据更新资源数
partitionCount数据分片数
dataSource数据源配置
type数据源类型: 仅支持odps、swif...
dataTimeSec追增量时间戳
autoBuildIndex是否自动索引重建
请选择布尔值
config数据源配置
endpointodps相关
accessKeyodps数据源ak
accessSecretodps数据源ak secret
projectodps数据源项目名称
partition数据源为odps时必填
tablesaro、odps相关
ossPathoss数据源相关
bucketoss bucket
catalog
database
tag
rawSchema如果用户传了rawSchema
primaryKey主键字段
fieldSchemakey: 字段名
:
vectorIndex索引结构
0
indexName索引结构名称
vectorField向量字段
sparseIndexField稀疏向量下标字段
sparseValueField稀疏向量值字段
dimension向量维度
vectorIndexType向量索引算法
distanceType距离类型
namespace命名空间字段
advanceParams索引结构配置
buildIndexParams索引构建参数
searchIndexParams索引检索参数
minScanDocCnt召回候选集的个数最小值
linearBuildThreshold线性构建的阈值
dataProcessConfig字段处理配置
0字段处理配置详细信息
operator字段处理方式 (copy: 将源字段拷...
dstField目标字段
srcField源字段
params配置模型信息
vectorModel向量化模型
vectorModal数据类型
srcFieldConfig向量化信息来源
ossEndpointOSS区域地址
ossBucketOSSBucket
uid云账号id
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

方法

POST

URI

/openapi/ha3/instances/{instanceId}/tables

请求语法

POST /openapi/ha3/instances/{instanceId}/tables HTTP/1.1

路径参数

字段名称字段详情
instanceIdstring

实例 id。

示例值:ha-cn-pl32rf0****参考取值来源:
    ListInstances
    UpdateInstance
    CreateInstance
    CloneSqlInstance
    ExecuteSqlInstance

请求参数

字段名称字段详情
dryRunboolean

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

示例值:true
bodyobject

body

请求说明

请求示例



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

注意 示例仅列举最简单的参数, 更多自定义参数请参考请求参数

{
    "name": "api",
    "partitionCount": 1,
    "primaryKey": "id",
    "fieldSchema": {
        "id": "INT64",
        "source_image": "STRING",
        "namespace": "STRING",
        "source_image_vector": "MULTI_FLOAT"
    },
    "vectorIndex": [
        {
            "indexName": "test_index_1",
            "vectorField": "source_image_vector",
            "vectorIndexType": "HNSW",
            "dimension": "512",
            "distanceType": "InnerProduct"
        }
    ]
}

详情可参考响应结构

返回参数

字段名称字段详情
requestIdstring

请求 ID。

示例值:2AE63638-5420-56DC-BF59-37D8174039A0
resultobject

返回结果。

示例值:{}
变更历史
变更时间变更内容概要操作
2024-09-18
变更请求参数body