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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:getParameter	read	instance	g:EnterpriseProjectId g:ResourceTag/<tag-key>	rds:param:list	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:getParameter

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:param:list

URI

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

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 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 Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. Constraints N/A 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	Definition Database version name. Range N/A
datastore_name	String	Definition Database name. Range N/A
created	String	Definition 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. Range N/A
updated	String	Definition 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. Range N/A
configuration_parameters	Array of objects	Definition 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	Definition Parameter name. Range N/A
value	String	Definition Parameter value. Range N/A
restart_required	Boolean	Definition Whether a reboot is required. Range false: A reboot is not required. true: A reboot is required.
readonly	Boolean	Definition Whether the parameter is read-only. Range false: The parameter is not read-only. true: The parameter is read-only.
value_range	String	Definition Parameter value range. 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	Definition Parameter type. Range The value can be string, integer, boolean, list, or float.
description	String	Definition Parameter description. 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.
	}]
}