CreateIndex
创建索引。 说明： 1. 只支持创建标量索引。 2. 创建索引期间禁写表。 3. 在单表数据量大的情况下创建索引，过程中会占用实例CPU、IO资源，如果影响实例可用性请调用CancelCreateIndexJob取消创建索引
服务地址：
华东1 金融云
输入参数
只看必填
RegionId实例所在的地域ID
DBInstanceId实例ID
WorkspaceId多数据库实例组成的Workspace的Id
Namespace命名空间
NamespacePassword命名空间对应的密码
Collection集合名
IndexName索引名称
IndexField索引字段
IndexConfig索引参数
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
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
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求参数

字段名称字段详情
RegionIdstring

实例所在的地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
DBInstanceIdstring

实例 ID。展开详情

示例值:gp-xxxxxxxxx参考取值来源:
    UpgradeDBInstance
    CreateDBInstance
    UpdateDBInstancePlan
    DescribeDBInstances
    PauseInstance
    ModifyDBInstancePayType
    ResumeInstance
    UploadDocumentAsync
    DownloadDiagnosisRecords
    UnloadSampleData
WorkspaceIdstring

多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空，当和 DBInstanceId 同时指定时以此参数为准。

示例值:gp-ws-*****枚举值:ipl2cosine
Namespacestring

命名空间。展开详情

示例值:mynamespace参考取值来源:
    ListNamespaces
    CreateNamespace
NamespacePasswordstring

命名空间对应的密码。展开详情

示例值:testpassword
Collectionstring

集合名。展开详情

示例值:testcollection参考取值来源:
    ListCollections
    CreateCollection
    UpsertCollectionData
IndexNamestring

索引名称。

示例值:testindex
IndexFieldstring

索引字段，仅支持单个字段，且字段必须属于 Metadata 里定义的 key。

示例值:title
IndexConfigstring

索引参数。如果不传，默认创建 b-tree 索引。展开详情

示例值:{"b-tree":{"fillFactor":90}} 或者 {"gin":{"fastUpdate":false}}

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

接口返回详细信息。

示例值:Successfully create job
Statusstring

API 执行状态，取值如下：展开详情

示例值:success
JobIdstring

任务 ID，用于后续查看任务状态或者取消任务。

示例值:231460f8-75dc-405e-a669-0c5204887e91
变更历史
变更时间变更内容概要操作
2025-01-24
新增OpenAPI，创建索引