# 插件安装 - InstallingaPlug-in #### 功能介绍 安装数据库插件。 - 调用接口前，您需要了解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=InstallKernelPlugin)中调试该接口。 #### 前提条件 - 已在[云商店](https://marketplace.huaweicloud.com/contents/8f3c73fa-0a58-4fc9-8136-02eb1b8146c7#productid=OFFI1225647236272160768)购买License，并联系第三方厂商获取插件包的下载地址以及sha256信息。联系信息参见"[云商店](https://marketplace.huaweicloud.com/contents/8f3c73fa-0a58-4fc9-8136-02eb1b8146c7#productid=OFFI1225647236272160768) \>服务支持 \>服务信息"模块。 - 安装插件前需要先将插件包上传至最终租户OBS中。插件包上传请参考[上传对象](https://support.huaweicloud.com/usermanual-obs/obs_03_1002.html)章节。 #### URI POST /v3/{project_id}/instances/{instance_id}/kernel-plugin 表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）功能，赋能传统关系型数据库。 **默认取值** **：** 不涉及。 | | url | 是 | String | **参数解释：** 插件包安装链接。要求为OBS租户桶分享链接。 获取方式请参考[通过URL访问对象](https://support.huaweicloud.com/usermanual-obs/obs_03_0319.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | sha_256 | 是 | String | **参数解释：** 插件包对应的sha256字符串。 请联系第三方厂商获取插件包的sha256。联系信息参见"[云商店](https://marketplace.huaweicloud.com/contents/8f3c73fa-0a58-4fc9-8136-02eb1b8146c7#productid=OFFI1225647236272160768) \>服务支持 \>服务信息"模块。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | #### 响应参数 表4参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释：** 插件安装工作流ID。 **取值范围：** 不涉及。 | #### 请求示例 ``` https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/kernel-plugin { "plugin_name" : "postgis", "url" : "xxxx.obs.bucket1", "sha_256" : "791a8d68064ca3208b52ac2584b3b1ab89e4945069baf48e2b14ed5a7151889b" } ``` #### 响应示例 ``` { "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" } ``` #### 状态码 - 正常 202 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。