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

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

Yes

String

Definition

Database name.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

Object array

Array

Definition

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

Parameter

Type

Description

extension_name

String

Definition

Plug-in extension name.

Range

N/A

status

String

Definition

Plug-in extension status.

Range

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_gis_pg&plugin_name=postgis

Example Response

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

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Plug-in Management