查询参数模板

功能介绍

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

该接口计划于2025-03-31下线，建议及时切换到新接口查询参数模板。

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

• URI格式

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

• URI样例

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

• 参数说明

  表1 参数说明

  名称	是否必选	参数类型	说明
  project_id	是	String	租户在某一Region下的project ID。 获取方法请参见获取项目ID。

请求消息

无

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  configurations	Array of objects	参数模板列表。 详情请参见表3。
  total_count	Integer	参数模板的总数

  表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":"1ad028f5f6b8482483948860feb33339pr07",
              "name":"DBS_GaussDB_ParameterTemple_Apply_001",
              "description":"GaussDB-Test",
              "datastore_version_name":"8.0",
              "datastore_name":"gaussdb-mysql",
              "created":"2020-04-08 07:12:17",
              "updated":"2020-04-08 07:12:17",
              "user_defined":true,
          }
  ]
  }

状态码

请参见状态码。

错误码

请参见错误码。