CreateIndex_云原生数据仓库 AnalyticDB PostgreSQL版_API文档

插件下载了解更多
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.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
gpdb:CreateIndex
Create
Collection
acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

请求参数

字段名称字段详情
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,创建索引

相关示例