Obtaining the Parameter Template of a Specified DB Instance

Function

This API is used to obtain information about the parameter template of a specified DB instance.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/configurations

Parameter description

**Table 1** Parameters
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. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	String	Explanation: Instance ID. Constraints: N/A Value range: N/A Default value: N/A

Request

Request parameters
None

URI example

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
datastore_version_name	String	Explanation: Database version name. Value range: N/A
datastore_name	String	Explanation: Database name. Value range: N/A
created	String	Explanation: 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. Value range: N/A
updated	String	Explanation: 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. Value range: N/A
configuration_parameters	Array of objects	Explanation: Parameters defined by users based on a default parameter template. For details, see Table 3.

**Table 3** configuration_parameters field data structure description
Parameter	Type	Description
name	String	Explanation: Parameter name. Value range: N/A
value	String	Explanation: Parameter value. Value range: N/A
restart_required	Boolean	Explanation: Whether a reboot is required. Value range: false: A reboot is not required. true: A reboot is required.
readonly	Boolean	Explanation: Whether the parameter is read-only. Value range: false: The parameter is not read-only. true: The parameter is read-only.
value_range	String	Explanation: Parameter value range. Value range: For example, 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	Explanation: Parameter type. Value range: The value can be string, integer, boolean, list, or float.
description	String	Explanation: Parameter description. Value range: N/A

Example normal response

{
	"datastore_version_name": "5.7",
	"datastore_name": "mysql",
	"created": "2018-10-11 11:40:44",
	"updated": "2018-10-11 11:40:44",
	"configuration_parameters": [{
		"name": "auto_increment_increment",
		"value": "1",
		"restart_required": false,
		"readonly": false,
		"value_range": "1-65535",
		"type": "integer",
		"description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
	}]
}