Updated on 2024-07-25 GMT+08:00

Configuring Plug-in Extensions

Function

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

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

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request 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 3 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" 
}

Example Response

"SUCCESS"

Status Code

Error Code

For details, see Error Codes.