获取参数模板列表 - ListConfigurations

功能介绍

获取参数模板列表，包括所有数据库的默认参数模板和用户创建的参数模板。

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要了解请求Header参数说明。

授权信息

接口约束

• 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。

URI

• URI格式

  GET /v3/{project_id}/configurations

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	参数解释： 租户在某一region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求消息

• 请求参数

  无。

• URI样例

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

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  configurations	Array of objects	参数解释： 参数模板列表。 详情请参见表3。

  表3 configurations字段数据结构说明

  名称	参数类型	说明
  id	String	参数解释： 参数模板ID。 取值范围： 不涉及。
  name	String	参数解释： 参数模板名称。 取值范围： 不涉及。
  description	String	参数解释： 参数模板描述。 取值范围： 不涉及。
  datastore_version_name	String	参数解释： 数据库版本。 取值范围： 不涉及。
  datastore_name	String	参数解释： 数据库引擎。 取值范围： 不涉及。
  created	String	参数解释： 创建时间。 取值范围： 格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  updated	String	参数解释： 更新时间。 取值范围： 格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  user_defined	Boolean	参数解释： 是否是用户自定义参数模板。 取值范围： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。

• 正常响应样例

  {
  	"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
  		}                
  	]
  }

• 异常响应

  请参见异常响应结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。