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

获取参数模板详情 - ShowGaussMySqlConfiguration

功能介绍

获取指定参数模板的参数信息。

接口约束

该接口支持TaurusDB集群-独享版。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:get

    Read

    -

    -

    gaussdb:param:list

    -

URI

GET /v3/{project_id}/configurations/{configuration_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

configuration_id

是

String

参数解释：

参数模板ID。

约束限制：

不涉及。

取值范围：

获取方法参见查询参数模板 - ListGaussMySqlConfigurations。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

configurations

ConfigurationSummary2 object

参数解释：

参数模板信息。

parameter_values

Map<String,String>

参数解释：

参数名和参数值映射关系。用户可以基于默认参数模板的参数，自定义的参数值。
表4 ConfigurationSummary2

参数

参数类型

描述

id

String

参数解释：

参数组ID。

取值范围：

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

name

String

参数解释:

参数组名称。

取值范围：

与请求参数中的参数组名称保持一致。

description

String

参数解释：

参数组描述。

取值范围：

与请求参数中的参数组描述保持一致。

datastore

DatastoreResult object

参数解释：

数据库对象。

created

String

参数解释：

创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量。

取值范围：

不涉及。

updated

String

参数解释：

更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量。

取值范围：

不涉及。
表5 DatastoreResult

参数

参数类型

描述

type

String

参数解释：

数据库引擎。

约束限制：

不涉及。

取值范围：

现在只支持gaussdb-mysql。

默认取值：

不涉及。

version

String

参数解释：

数据库版本，获取方法请参见查询数据库引擎的版本- ShowGaussMySqlEngineVersion返回的name字段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

获取参数模板详情。

GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr07

响应示例

状态码： 200

Success.

{
  "configurations" : {
    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
    "name" : "myparameter",
    "description" : "parameter1",
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0"
    },
    "created" : "2022-05-15T11:53:34+0000",
    "updated" : "2022-05-15T11:53:34+0000"
  },
  "parameter_values" : {
    "binlog_rows_query_log_events" : "OFF",
    "mount_vip_when_failover" : "ON",
    "log-bin" : "ON",
    "gtid_mode" : "ON",
    "enforce_gtid_consistency" : "ON",
    "innodb_online_alter_log_max_size" : "134217728",
    "binlog_gtid_simple_recovery" : "ON",
    "max_user_connections" : "10"
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理