获取指定参数模板的参数

功能介绍

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

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

接口约束

• 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。

URI

• URI格式

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

• URI样例

  https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。
  config_id	是	参数模板ID。 当“config_id”为空（非空格）时，相当于获取参数模板列表的URL，具体请参见获取参数模板列表。

请求消息

无。

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  id	String	参数模板ID。
  name	String	参数模板名称。
  datastore_version_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 objects	参数对象，用户基于默认参数模板自定义的参数配置。 详情请参见表3。

  表3 configuration_parameters字段数据结构说明

  名称	参数类型	说明
  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-mysql-5.6", 
      "datastore_version_name": "5.6", 
      "datastore_name": "mysql", 
      "description": "Default parameter group for mysql 5.6", 
      "created": "2017-05-05T04:40:51+0800", 
      "updated": "2017-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. " 
        } 
      ] 
  }

• 异常响应

  请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。