文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 参数模板管理/ 查询参数模板- ListGaussMySqlConfigurations
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询参数模板 - ListGaussMySqlConfigurations

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:list

    List

    -

    -

    gaussdb:param:list

    -

URI

GET /v3/{project_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0

默认取值：

0

limit

否

Integer

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100

默认取值：

100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us
  • zh-cn

默认值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

configurations

Array of ConfigurationSummary objects

参数解释：

参数模板信息。

total_count

Integer

参数解释：

参数模板的总数。

取值范围：

≥0
表5 ConfigurationSummary

参数

参数类型

描述

id

String

参数解释：

参数组ID。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为pr07，长度为36个字符。

name

String

参数解释：

参数组名称。

取值范围：

不涉及。

datastore_version_name

String

参数解释：

数据库版本。

取值范围：

8.0

datastore_name

String

参数解释：

数据库名称。

取值范围：

GaussDB(for MySQL)

created

String

参数解释：

参数组创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

取值范围：

不涉及。

updated

String

参数解释：

参数组更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

取值范围：

不涉及。

user_defined

Boolean

参数解释：

是否是用户自定义参数模板。

取值范围：

  • false：表示为系统默认参数模板。
  • true：表示为用户自定义参数模板。

description

String

参数解释：

参数组描述。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询参数模板。

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

响应示例

状态码： 200

Success.

{
  "total_count" : 1,
  "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
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理