Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Plug-in Management/ Querying Plug-in Extensions of an Instance
Updated on 2024-07-25 GMT+08:00
View PDF

Querying Plug-in Extensions of an Instance

Function

This API is used to query plug-in extensions of an instance. Before calling this API:

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/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_name

Yes

String

Database name.

Response Parameters

Table 3 Response parameters

Parameter

Type

Description

Object array

Array

Plug-in extension information. For details, see Table 4.
Table 4 Plug-in extension field description

Parameter

Type

Description

extension_name

String

Plug-in extension name.

status

String

Plug-in extension status. on means to enable the extension, and off means to disable the extension.

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/plugin-extensions
{ 
  "db_name" : "test", 
  "plugin_name" : "postgis" 
}

Example Response

[ { 
  "extension_name" : "postgis_raster", 
  "status" : "on"
} ]

Status Code

Error Code

For details, see Error Codes.

Parent topic: Plug-in Management