Help Center/ GaussDB/ API Reference/ Historical APIs/ Parameter Configuration/ Obtaining Parameter Templates (v3.1)
Updated on 2025-08-11 GMT+08:00

Obtaining Parameter Templates (v3.1)

Function

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

URI

GET /v3.1/{project_id}/configurations?offset={offset}&limit={limit}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

For details about how 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

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 0 and limit is set to 10, only the 1st to 10th records are displayed.

Constraints

N/A

Range

[0,2^31-1]

Default Value

0: The query starts from the first data record.

limit

No

Integer

Definition

Number of records to be queried. 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

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

configurations

Array of objects

Definition

Parameter template information. For details, see Table 3.

count

Integer

Definition

Total number of records.

Range

[0, 2^31 – 1]

Table 3 configurations field data structure description

Parameter

Type

Description

id

String

Definition

Unique ID of a parameter template.

Range

The value can contain 36 characters. Only letters and digits are allowed.

name

String

Definition

Parameter template name.

Range

The value can contain 1 to 64 characters and is case-sensitive. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed

description

String

Definition

Parameter template description.

Range

The value can contain up to 256 characters but cannot contain carriage return characters. The following special characters are not allowed: !<"='>&

datastore_version

String

Definition

Engine version.

Range

N/A

datastore_name

String

Definition

Engine name.

Range

GaussDB

ha_mode

String

Definition

Instance type.

Range

The value is case-sensitive. The value Enterprise indicates a distributed instance (Enterprise Edition). The value centralization_standard indicates a centralized instance.

created

String

Definition

Creation time in the yyyy-MM-dd HH:mm:ss format. for example, 2024-07-03 14:18:55.

Range

N/A

updated

String

Definition

Update time in the "yyyy-MM-dd HH:mm:ss" format, for example, 2024-07-03 14:18:55.

Range

N/A

user_defined

Boolean

Definition

Whether the parameter template is a custom template.

Range

  • false: The parameter template is a default template.
  • true: The parameter template is a custom template.

Example Request

Querying parameter templates

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/configurations?offset=1&limit=3

Example Response

Parameter templates queried.

{
    "count": 3,
    "configurations": [
        {
            "id": "b000d7c91f1749da87315700793a11d4pr14",
            "name": "Default-GaussDB-EE-1.0-Dist-Combined (4 replicas)",
            "description": "Default parameter template for GaussDB-Enterprise Edition-1.0-Distributed-combined (4 replicas)",
            "created": "2022-03-23 07:20:11",
            "updated": "2022-03-23 07:20:11",
            "datastore_version": "1.0",
            "datastore_name": "GaussDB",
            "ha_mode": "combined",
            "user_defined": false
        },
        {
            "id": "8d99f260ea1b4493a1b349e7abce5c09pr14",
            "name": "Default-Finance-Edition-GaussDB-1.3-Combined",
            "description": "Default parameter template for Finance Edition GaussDB 1.3-Combined",
            "created": "2022-03-23 07:20:11",
            "updated": "2022-03-23 07:20:11",
            "datastore_version": "1.1",
            "datastore_name": "GaussDB",
            "ha_mode": "combined",
            "user_defined": false
        },
        {
            "id": "0f44b65521a8414d8b8811df810d94ccpr14",
            "name": "Default-Finance-Disaster-GaussDB-1.3-Combined",
            "description": "Default parameter template for Finance Disaster GaussDB 1.3-Combined",
            "created": "2022-03-23 07:20:11",
            "updated": "2022-03-23 07:20:11",
            "datastore_version": "1.2",
            "datastore_name": "GaussDB",
            "ha_mode": "combined",
            "user_defined": false
        }
	]
}

Status Codes

Error Codes

For details, see Error Codes.