文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 参数管理/ 获取指定参数模板的参数
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

获取指定参数模板的参数

功能介绍

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

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

  • URL格式

GET /v3/{project_id}/configurations/{config_id}

  • 参数说明
表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

config_id

是

String

参数模板ID。

当“config_id”为空（非空格）时，相当于获取参数模板列表的URL，具体请参见获取参数模板列表。

请求参数

无。

请求示例

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

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

响应消息

  • 正常响应参数说明
表2 响应Body参数

参数

参数类型

描述

id

String

参数模板ID。

name

String

参数模板名称。

datastore_name

String

数据库名称。

description

String

描述。

created

String

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

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

updated

String

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

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

configuration_parameters

Array of ConfigurationParameters objects

参数对象，用户基于默认参数模板自定义的参数配置。
表3 ConfigurationParameters

参数

参数类型

描述

name

String

参数名称。

value

String

参数值。

restart_required

Boolean

是否需要重启。

  • “false”表示否。
  • “true”表示是。

readonly

Boolean

是否只读。

  • “false”表示否。
  • “true”表示是。

value_range

String

参数值范围，如integer取值0-1、boolean取值true或者false等。

type

String

参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。

description

String

参数描述。
  • 正常响应示例
{
  "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
  "name": "default-ddm-test",
  "datastore_name": "ddm",
  "description": "Default parameter group for ddm-test",
  "created": "2020-05-05T04:40:51+0800",
  "updated": "2020-05-05T04:40:51+0800",
  "configuration_parameters": [
    {
      "name": "auto_increment_increment",
      "value": "1",
      "restart_required": false,
      "readonly": true,
      "value_range": "1-65535",
      "type": "integer",
      "description": "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns."
    },
    {
      "name": "autocommit",
      "value": "ON",
      "restart_required": false,
      "readonly": true,
      "value_range": "ON|OFF",
      "type": "boolean",
      "description": "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. "
    }
  ]
}

状态码

错误码

请参见错误码。

父主题： 参数管理

相关文档