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

Installing a Plug-in

Function

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

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/kernel-plugin

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.

url

Yes

String

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

sha_256

Yes

String

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

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

job_id

String

ID of the plug-in installation workflow.

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 Code

Error Code

For details, see Error Codes.

Parent topic: Plug-in Management