Obtaining Parameters in a Specified Parameter Template

Function

This API is used to obtain information about a specified parameter template.

Constraints

None

URI

URL format

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

Parameter description

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
config_id	Yes	String	Parameter template ID. When this parameter is left empty (not space), the URL of the parameter template list is obtained. For details, see Obtaining Parameter Templates.

Request Parameters

None

Example Request

This API is used to obtain information about a specified parameter template.

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

Response

Normal response

**Table 2** Response body parameters
Parameter	Type	Description
id	String	Parameter template ID
name	String	Parameter template name
datastore_name	String	Database name
description	String	Description
created	String	Creation time. The format is yyyy-MM-ddTHH:mm:ssZ. 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 offset is +0800.
updated	String	Update time. The format is yyyy-MM-ddTHH:mm:ssZ. 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 offset is +0800.
configuration_parameters	Array of ConfigurationParameters objects	Parameters defined by users based on a default parameter template

**Table 3** ConfigurationParameters
Parameter	Type	Description
name	String	Parameter name
value	String	Parameter value
restart_required	Boolean	Whether a restart is required. The value can be: false: indicates that a restart is not required. true: indicates that a restart is required.
readonly	Boolean	Whether the parameter is read-only. The value can be: false: indicates that the parameter is not read-only. true: indicates that the parameter is read-only.
value_range	String	Indicates the parameter value range. If the type is integer, the value is 0 or 1. If the type is boolean, the value is true or false.
type	String	Parameter type. The value can be string, integer, boolean, list, or float.
description	String	Parameter description

Normal response example

{
  "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
  "name": "default-ddm-test",
  "datastore_name": "ddm",
  "description": "Default parameter group for ddm-test",
  "created": "2020-05-05T04:40:51+0800",
  "updated": "2020-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. "
    }
  ]
}