# 配置插件拓展功能 - ConfiguringPlug-inExtensions #### 功能介绍 配置插件拓展功能，指定数据库进行开启或者关闭。 - 调用接口前，您需要了解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=ResumePluginExtensions)中调试该接口。 #### URI POST /v3/{project_id}/instances/{instance_id}/config-plugin-extensions 表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个字符。 **默认取值** **：** 不涉及。 | #### 请求参数 表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请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | plugin_name | 是 | String | **参数解释：** 插件包名称。 **约束限制：** 不涉及。 **取值范围：** postgis：超图公司开发的一款GIS插件，可以扩展地理空间数据的存储和管理能力，支持二三维一体化的空间数据存储能力，提供专业的GIS（Geographic Information System）功能，赋能传统关系型数据库。 **默认取值** **：** 不涉及。 | | db_list | 是 | Array of strings | **参数解释：** 数据库名称列表。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取数据库名称。 **约束限制：** 不涉及。 | | extension_name | 是 | String | **参数解释：** 拓展功能名称。 **约束限制：** 不涉及。 **取值范围：** - postgis：与数据库适配的PostGIS矢量模块。 - postgis_raster：与数据库适配的PostGIS栅格模块。 - postgis_sfcgal：与数据库适配的PostGIS三维算法相关模块。 - postgis_topology：与数据库适配的PostGIS拓扑相关模型。 - yukon_geomodel：三维模型数据模块。 - yukon_geogridcoder：空间网格编码模块。 **默认取值** **：** 不涉及。 | | extension_action | 是 | String | **参数解释：** 拓展相关操作。 **约束限制：** 不涉及。 **取值范围：** - on：表示开启。 - off：表示关闭。 **默认取值** **：** 不涉及。 | #### 响应参数 表4响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 值 | String | **参数解释：** 正常响应。 **取值范围：** "SUCCESS"：表示成功。 | #### 请求示例 ``` https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/config-plugin-extensions { "plugin_name" : "postgis", "db_list" : [ "test" ], "extension_name" : "postgis", "extension_action" : "on" } ``` #### 响应示例 ``` "SUCCESS" ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。