Updated on 2025-08-11 GMT+08:00

Configuring the Plug-in License

Function

This API is used to configure the plug-in license. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/kernel-plugin-license

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

license_str

Yes

String

Definition

String corresponding to the license file.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

Value

String

Definition

Normal response.

Range

SUCCESS

Example Request

Configuring the content of the license file of the plug-in

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/kernel-plugins-license
{ 
  "license_str" : "90ca926757144a2d98d78f727dc56664" 
}

Example Response

"SUCCESS"

Status Codes

Error Codes

For details, see Error Codes.