# 查询索引 - DescribeIndex
#### 功能介绍
查询指定索引的详细信息。
#### URI
POST /v1/indexes/describe
#### 请求参数
表1请求Body参数 
| 参数              | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| store_name      | 是    | String | **参数解释：** 知识仓实例名称，region内唯一。 **约束限制：** 长度范围为3到63个字符，支持小写字母、数字、中划线（ - ），第一个字符只能够是小写字母，中划线（ - ）不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                          |
| collection_name | 是    | String | **参数解释：** collection名称，知识仓内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（ - ）和下划线（ _ ），大小写敏感。第一个字符只能够是下划线（ _ ）和字母，中划线（ - ）不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。   |
| index_name      | 是    | String | **参数解释：** 创建的索引名称，collection内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（ - ）和下划线（ _ ），大小写敏感。第一个字符只能够是下划线（ _ ）和字母，中划线（ - ）不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码：200**
表2响应Body参数 
| 参数      | 参数类型                                                                       | 描述                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| code    | String                                                                     | **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。 |
| message | String                                                                     | **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。         |
| data    | [describe_index_data] object | **参数解释：** 响应数据。 **约束限制：** 不涉及。                                                                                                                                                                          |
   
 表3describe_index_data 
| 参数              | 参数类型                                                     | 描述                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| store_name      | String                                                   | **参数解释：** 知识仓实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。      |
| collection_name | String                                                   | **参数解释：** collection名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| index_desc      | [index_desc] object | **参数解释：** 索引描述信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。       |
   
 表4index_desc 
| 参数           | 参数类型                 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|
| index_name   | String               | **参数解释：** 描述的索引名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                               |
| field_name   | String               | **参数解释：** 索引对应的字段名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                             |
| index_params | Map\<String,Object\> | **参数解释：** 索引的参数信息。详情请查阅CreateIndex接口中 index_param结构中params字段的描述。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。                                                                                 |
| index_state  | String               | **参数解释：** 索引状态。 **约束限制：** 不涉及。 **取值范围：** -"InProgress"：索引正在构建中或还未开始构建。 -"Finished"：索引构建完成。 -"Failed"：索引构建失败。 **默认取值:** 不涉及。 |
   
**状态码：400**
表5响应Body参数 
| 参数      | 参数类型   | 描述                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| code    | String | **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。 |
| message | String | **参数解释：** 描述信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。        |
   
#### 请求示例
```
/v1/indexes/describe
{
  "store_name" : "test-storename",
  "collection_name" : "test-collection",
  "index_name" : "vector_index"
}
```
#### 响应示例
**状态码：200**
查询索引成功
```
{
  "code" : "LMS.00000000",
  "data" : {
    "collection_name" : "test-collection",
    "index_desc" : {
      "field_name" : "vector",
      "index_name" : "vector_index",
      "index_params" : {
        "beamwidth" : "4",
        "encoding_type" : "PQ",
        "index_type" : "HANNS",
        "max_degree" : "56",
        "metric_type" : "L2",
        "pq_code_budget_gb_ratio" : "0.125",
        "search_list_size" : "200"
      },
      "index_state" : "Finished"
    },
    "store_name" : "test-storename"
  },
  "message" : "describe index success"
}
```
**状态码：400**
Bad Request
```
{
  "code" : "LMS.00001001",
  "message" : "ErrInvalidParameter: The input parameter is incorrect."
}
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | 查询索引成功      |
| 400 | Bad Request |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dwr/ErrorCode.html)。