Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Parameter Management/ Obtaining Parameters in a Specified Parameter Template
Updated on 2025-08-20 GMT+08:00

Obtaining Parameters in a Specified Parameter Template

Function

This API is used to obtain parameters of a specified parameter template.

Constraints

  • The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.

URI

  • URI format

    GET /v3/{project_id}/configurations/{config_id}

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    config_id

    Yes

    Definition

    Specifies the parameter template ID.

    Constraints

    N/A

    Range

    When this parameter is empty (not space), the URL of the parameter template list is obtained. For details, see Obtaining a Parameter Template List.

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    id

    String

    Definition

    Indicates the parameter template ID.

    Range

    N/A

    name

    String

    Definition

    Indicates the parameter template name.

    Range

    N/A

    datastore_version_name

    String

    Definition

    Indicates the database version name.

    Range

    N/A

    datastore_name

    String

    Definition

    Indicates the database name.

    Range

    N/A

    description

    String

    Definition

    Indicates the parameter template description.

    Range

    N/A

    created

    String

    Definition

    Indicates the creation time.

    Range

    The value is 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

    Definition

    Indicates the update time.

    Range

    The value is 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.

    configuration_parameters

    Array of objects

    Definition

    Indicates the parameters defined by users based on the default parameter templates.

    For details, see Table 3.

    Table 3 configuration_parameters field data structure description

    Parameter

    Type

    Description

    name

    String

    Definition

    Indicates the parameter name.

    Range

    N/A

    value

    String

    Definition

    Indicates the parameter value.

    Range

    N/A

    restart_required

    Boolean

    Definition

    Indicates whether a restart is required.

    Range

    • false: indicates that a restart is not required.
    • true: indicates that a restart is required.

    readonly

    Boolean

    Definition

    Indicates whether the parameter is read-only.

    Range

    • false: indicates that the parameter is not read-only.
    • true: indicates that the parameter is read-only.

    value_range

    String

    Definition

    Indicates the parameter value range.

    Range

    If the parameter type is integer, the value is 0 or 1. If the type is boolean, the value is true or false.

    type

    String

    Definition

    Indicates the parameter type.

    Range

    The value can be string, integer, boolean, list, or float.

    description

    String

    Definition

    Indicates the parameter description.

    Range

    N/A

  • Example normal response
    { 
        "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", 
        "name": "default-mysql-5.7", 
        "datastore_version_name": "5.7", 
        "datastore_name": "mysql", 
        "description": "Default parameter group for mysql 5.7", 
        "created": "2017-05-05T04:40:51+0800", 
        "updated": "2017-05-05T04:40:51+0800", 
        "configuration_parameters": [ 
          { 
            "name": "auto_increment_increment", 
            "value": "1", 
            "restart_required": false, 
            "readonly": true, 
            "value_range": "1-65535", 
            "type": "integer", 
            "description": "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns." 
          }, 
          { 
            "name": "autocommit", 
            "value": "ON", 
            "restart_required": false, 
            "readonly": true, 
            "value_range": "ON|OFF", 
            "type": "boolean", 
            "description": "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. " 
          } 
        ] 
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.