Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Plug-in Management/ Installing a Plug-in
Updated on 2025-08-11 GMT+08:00
View PDF
Share

Installing a Plug-in

Function

This API is used to install a database plug-in. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/kernel-plugin

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

url

Yes

String

Definition

URL of the plug-in installation package. The URL must be a shared object URL of OBS buckets.

Constraints

N/A

Range

N/A

Default Value

N/A

sha_256

Yes

String

Definition

SHA-256 string corresponding to the plug-in package.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

job_id

String

Definition

ID of the plug-in installation workflow.

Range

N/A

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/kernel-plugin
{ 
  "plugin_name" : "postgis", 
  "url" : "xxxx.obs.bucket1", 
  "sha_256" : "791a8d68064ca3208b52ac2584b3b1ab89e4945069baf48e2b14ed5a7151889b" 
}

Example Response

{ 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Plug-in Management