# 查询插件列表 - QueryingAdd-ons #### 功能介绍 查询支持的插件信息。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListPluginInfoList)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/plugins?limit={limit}\&offset={offset}\&plugin_name={plugin_name} 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值**： 默认为100。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2-11条数据。 **约束限制：** 不涉及。 **取值范围：** \[0, 2147483647\] **默认取值**： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | plugin_name | 否 | String | **参数解释：** 插件包名称。 **约束限制：** 不涉及。 **取值范围：** - postgis：超图公司开发的一款GIS插件，可以扩展地理空间数据的存储和管理能力，支持二三维一体化的空间数据存储能力，提供专业的GIS（Geographic Information System）功能，赋能传统关系型数据库。 **默认取值** **：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 插件数量。 **取值范围：** 不涉及。 | | plugins | Array of objects | **参数解释：** 插件详细信息。具体请参见[表4]。 **取值范围：** 不涉及。 | 表4plugins | 参数 | 参数类型 | 描述 | |:---|:---|:---| | plugin_name | String | **参数解释：** 插件名称。 **取值范围：** - postgis：超图公司开发的一款GIS插件，可以扩展地理空间数据的存储和管理能力，支持二三维一体化的空间数据存储能力，提供专业的GIS（Geographic Information System）功能，赋能传统关系型数据库。 | | installed | Boolean | **参数解释：** 是否安装此插件。 **取值范围：** - true：已安装。 - false：暂未安装。 | | port | String | **参数解释：** 插件端口。 **取值范围：** 不涉及。 | | plugin_version | String | **参数解释：** 插件版本。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/plugins?limit=10&offset=10 ``` #### 响应示例 ``` { "plugins": [ { "plugin_name": "postgis", "installed": true, "plugin_version": "1.0.0", "port": "8080" } ], "total_count": 2 } ``` #### 状态码 - 正常 202 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。