Configuring Plug-in Extensions

Function

This API is used to enable or disable plug-in extensions for a specific database. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
plugin_name	Yes	String	Definition Plug-in package name. Constraints N/A Range Only the PostGIS plug-in provided by Yukon is supported. Default Value N/A
db_list	Yes	Array of strings	Definition List of database names. Constraints N/A
extension_name	Yes	String	Definition Plug-in extension name. Constraints N/A Range N/A Default Value N/A
extension_action	Yes	String	Definition Operation to be performed on the plug-in extension. Constraints N/A Range on means to enable the extension, and off means to disable the extension. Default Value N/A

Response Parameters

**Table 4** Response parameters
Parameter	Type	Description
Value	String	Definition Normal response. Range SUCCESS

Example Request

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" 
}