文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 插件管理/ 配置插件拓展功能
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

配置插件拓展功能

功能介绍

配置插件拓展功能，指定数据库进行开启或者关闭。

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/config-plugin-extensions

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

语言。

缺省值：en-us

枚举值：

  • zh-cn
  • en-us
表3 请求Body参数

参数

是否必选

参数类型

描述

plugin_name

是

String

插件包名称。仅支持yukon的postgis插件。

db_list

是

Array of strings

数据库名称列表。

extension_name

是

String

拓展功能名称。

extension_action

是

String

拓展相关操作。on表示开启，off表示关闭。

响应参数

表4 响应参数

参数

参数类型

描述

值

String

正常响应返回SUCCESS。

请求示例

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/config-plugin-extensions
{ 
   "plugin_name" : "postgis", 
   "db_list" : [ "test" ], 
   "extension_name" : "postgis", 
   "extension_action" : "on" 
}

响应示例

"SUCCESS"

状态码

错误码

请参见错误码。

父主题： 插件管理