Querying Add-ons

This API is used to query information about supported add-ons. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/plugins?limit={limit}&offset={offset}&plugin_name={plugin_name}

**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. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed. Constraints N/A Range [1,100] Default Value 100
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 1 and limit is set to 10, only the 2nd to 11th records are displayed. Constraints N/A Range [0,2^31-1] Default Value 0: The query starts from the first data record.
plugin_name	No	String	Definition Add-on package name. Constraints N/A Range postgis 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. The value of X-Subject-Token in the response 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

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
total_count	Integer	Definition Number of add-ons. Range N/A
plugins	Array of objects	Definition Add-on details. For details, see Table 4. Range N/A

**Table 4** plugins
Parameter	Type	Description
plugin_name	String	Definition Add-on name. Range N/A
installed	Boolean	Definition Whether to install the add-on. Range N/A
port	String	Definition Add-on port. Range N/A
plugin_version	String	Definition Add-on version. Range N/A

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/plugins?limit=10&offset=10

Example Response

{
    "plugins": [
        {
            "plugin_name": "postgis",
            "installed": true,
            "plugin_version": "1.0.0",
            "port": "8080"
        }
    ],
    "total_count": 2
}