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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/config-plugin-extensions

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.
X-Language	No	String	Language. Default value: en-us Values: zh-cn en-us

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

Response Parameters

**Table 4** Response parameters
Parameter	Type	Description
Value	String	If the response is normal, SUCCESS is returned.

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