Obtaining a Parameter Template List

Function

This API is used to obtain the parameter template list, including default parameter templates of all databases and those created by users.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

URI

• URI format

  GET /v3/{project_id}/configurations

• 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

Request

• Request parameters

  None

Response

• Normal response

  Table 2 Parameters

  Parameter	Type	Description
  configurations	Array of objects	Definition Indicates the parameter template list. For details, see Table 3.

  Table 3 configurations field data structure description

  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
  description	String	Definition Indicates the parameter template description. 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
  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.
  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.
  user_defined	Boolean	Definition Indicates whether the parameter template is a custom template. Range false: The parameter template is a default parameter template. true: The parameter template is a custom template.

• Example normal response

  {
  	"configurations": [{
  			"id": "887ea0d1bb0843c49e8d8e5a09a95652pr01",
  			"name": "configuration_test",
  			"description": "configuration_test",
  			"datastore_version_name": "8.0",
  			"datastore_name": "mysql",
  			"created": "2019-05-15T11:53:34+0000",
  			"updated": "2019-05-15T11:53:34+0000",
  			"user_defined": true
  		},
  		{
  			"id": "3bc1e9cc0d34404b9225ed7a58fb284epr01",
  			"name": "Default-MySQL-5.7",
  			"description": "Default parameter group for MySQL 5.7",
  			"datastore_version_name": "5.7",
  			"datastore_name": "mysql",
  			"created": "2019-05-27T03:38:51+0000",
  			"updated": "2019-05-27T03:38:51+0000",
  			"user_defined": false
  		}                
  	]
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.