Obtaining Parameter Templates

Function

This API is used to obtain parameter templates, including all databases' default and custom parameter templates. Before calling this API:

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

URI

GET https://{Endpoint}/v3/{project_id}/configurations?offset={offset}&limit={limit}

**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.
offset	No	Integer	Index offset. If offset is set to N, the resource query starts from the N+1 data entry. The default value is 0, indicating that the query starts from the first data entry. The value cannot be a negative number. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th records are displayed.
limit	No	Integer	Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

Request Parameters

None

Response Parameters

**Table 2** Response parameters
Parameter	Type	Description
configurations	Array of objects	Parameter template information. For details, see Table 3.
count	Integer	Total number of records.

**Table 3** configurations field data structure description
Parameter	Type	Description
id	String	Parameter template ID.
name	String	Parameter template name.
description	String	Parameter template description.
datastore_version	String	Engine version.
datastore_name	String	Engine name.
ha_mode	String	Instance type.
created	String	Creation time in the "yyyy-MM-dd HH:mm:ss" format.
updated	String	Update time in the "yyyy-MM-dd HH:mm:ss" format.
user_defined	Boolean	Whether the parameter template is a custom template. false: The parameter template is a default template. true: The parameter template is a custom template.

Example Request

https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/configurations?offset=1&limit=3
https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations?offset=1&limit=3

Example Response

Parameter templates:

{
    "count": 3,
    "configurations": [
        {
            "id": "b000d7c91f1749da87315700793a11d4pr14",
            "name": "Default-Enterprise-Edition-GaussDB-1.0-INDEP",
            "description": "Default parameter template for Enterprise Edition GaussDB 1.0-Independent",
            "created": "2022-03-23 07:20:11",
            "updated": "2022-03-23 07:20:11",
            "datastore_version": "1.0",
            "datastore_name": "GaussDB",
            "ha_mode": "enterprise",
            "user_defined": false
        },
        {
            "id": "8d99f260ea1b4493a1b349e7abce5c09pr14",
            "name": "Default-Enterprise-Edition-GaussDB-1.1-INDEP",
            "description": "Default parameter template for Enterprise Edition GaussDB 1.1-Independent",
            "created": "2022-03-23 07:20:11",
            "updated": "2022-03-23 07:20:11",
            "datastore_version": "1.1",
            "datastore_name": "GaussDB",
            "ha_mode": "enterprise",
            "user_defined": false
        },
        {
            "id": "0f44b65521a8414d8b8811df810d94ccpr14",
            "name": "Default-Enterprise-Edition-GaussDB-1.2-INDEP",
            "description": "Default parameter template for Enterprise Edition GaussDB 1.2-Independent",
            "created": "2022-03-23 07:20:11",
            "updated": "2022-03-23 07:20:11",
            "datastore_version": "1.2",
            "datastore_name": "GaussDB",
            "ha_mode": "enterprise",
            "user_defined": false
        }
	]
}