DescribeIndex
获取索引详情
服务地址：
华东1 金融云
输入参数
只看必填
RegionId地域ID
DBInstanceId实例ID
WorkspaceId多数据库实例组成的Workspace的Id
Namespace命名空间
NamespacePassword命名空间对应的密码
Collection集合名
IndexName索引名称
插件下载了解更多
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
DBInstanceIdstring

实例 ID。展开详情

示例值:gp-xxxxxxxxx
WorkspaceIdstring

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

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

命名空间。展开详情

示例值:mynamespace
NamespacePasswordstring

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

示例值:testpassword
Collectionstring

集合名。展开详情

示例值:testcollection
IndexNamestring

索引名称。

示例值:testindex

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

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

接口返回详细信息。

示例值:success
Statusstring

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

示例值:success
Namespacestring

命名空间。

示例值:mynamespace
Collectionstring

集合名。

示例值:testcollection
IndexNamestring

索引名称。

示例值:testindex
IndexDefstring

索引的定义。

示例值:CREATE INDEX testindex ON mynamespace. testcollection
变更历史
暂无变更历史