文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 参数模板管理/ 查询参数模板
更新时间：2024-05-20 GMT+08:00
查看PDF
分享

查询参数模板

功能介绍

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

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

调试

您可以在API Explorer中调试该接口。

URI

GET /mysql/v3/{project_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

configurations

Array of ConfigurationSummary objects

参数模板信息。

total_count

Integer

参数模板的总数。
表4 ConfigurationSummary

参数

参数类型

描述

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，表示为用户自定义参数模板。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/configurations

响应示例

状态码： 200

Success.

{
  "configurations" : [ {
    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
    "name" : "configuration_test",
    "description" : "configuration_test",
    "datastore_version_name" : "8.0",
    "datastore_name" : "GaussDB(for MySQL)",
    "created" : "2019-05-15T11:53:34+0000",
    "updated" : "2019-05-15T11:53:34+0000",
    "user_defined" : true
  }, {
    "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07",
    "name" : "Default-GaussDBforMySQL",
    "description" : "Default parameter template for GaussDBforMySQL",
    "datastore_version_name" : "8.0",
    "datastore_name" : "GaussDB(for MySQL)",
    "created" : "2019-05-27T03:38:51+0000",
    "updated" : "2019-05-27T03:38:51+0000",
    "user_defined" : false
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 参数模板管理

相关文档