Updated on 2024-08-20 GMT+08:00

Obtaining Parameter Templates

Function

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

URI

GET https://{Endpoint}/v3/{project_id}/configurations?offset={offset}&limit={limit}
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

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

Default value:

None

offset

No

Integer

Explanation:

Index offset. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th records are displayed.

Restrictions:

None

Value range:

[0, 2^31-1]

Default value:

0 (indicating that the query starts from the first data record.)

limit

No

Integer

Explanation:

Number of records to be queried. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

Restrictions:

None

Value range:

[1, 100]

Default value:

100

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

configurations

Array of objects

Explanation:

Parameter template information. For details, see Table 3.

count

Integer

Explanation:

Total number of records.

Value range:

[0, 2^31 – 1]

Table 3 configurations field data structure description

Parameter

Type

Description

id

String

Explanation:

Parameter template ID, which is the unique ID of a parameter template.

Value range:

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

name

String

Explanation:

Parameter template name.

Value range:

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

description

String

Explanation:

Parameter template description.

Value 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

Explanation:

Engine version.

Value range:

None

datastore_name

String

Explanation:

Engine name.

Value range:

GaussDB

ha_mode

String

Explanation:

Instance type.

Value range:

The value is case-sensitive. The value Enterprise indicates the distributed instance (Enterprise Edition).

created

String

Explanation:

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

Value range:

None

updated

String

Explanation:

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

Value range:

None

user_defined

Boolean

Explanation:

Whether the parameter template is a custom template.

Value range:

  • 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
        }
	]
}

Status Code

Error Code

For details, see Error Codes.