Updated on 2024-09-11 GMT+08:00

Querying Parameter Templates

Function

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

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Querying Parameter Templates) before then.

URI

  • URI format

    GET https://{endpoint}/mysql/v3/{project_id}/configurations

  • Example

    GET https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region.

    To obtain this value, see Obtaining a Project ID.

Request

None

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    configurations

    Array of objects

    Parameter template list.

    For details, see Table 3.

    total_count

    Integer

    Total number of parameter templates.

    Table 3 configuration field data structure description

    Name

    Type

    Description

    id

    String

    Parameter template ID.

    name

    String

    Parameter template name.

    description

    String

    Parameter template description.

    datastore_version_name

    String

    DB version name.

    datastore_name

    String

    DB name.

    created

    String

    Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    updated

    String

    Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    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 normal response
    {
        "configurations":[
            {
                "id":"1ad028f5f6b8482483948860feb33339pr07",
                "name":"DBS_GaussDB_ParameterTemple_Apply_001",
                "description":"GaussDB-Test",
                "datastore_version_name":"8.0",
                "datastore_name":"gaussdb-mysql",
                "created":"2020-04-08 07:12:17",
                "updated":"2020-04-08 07:12:17",
                "user_defined":true,
            }
    ]
    }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.