获取参数模板详情

接口说明

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

约束说明

该接口仅支持DDS社区版。

调试

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

URI

• URI格式

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

• URI样例

  https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

请求消息

无。

响应消息

• 参数说明

  表2 响应Body参数

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

  表3 parameters字段数据结构说明

  名称	参数类型	说明
  name	String	参数名称。
  value	String	参数值。
  description	String	参数描述。
  type	String	参数类型.。 取值为“integer”，“string”，“boolean”，“float”或“list”。
  value_range	String	参数值范围。 如integer取值0-1，boolean取值true/false等。
  restart_required	Boolean	参数是否需要重启。 取值为“true”，需要重启。 取值为“false”，不需要重启。
  readonly	Boolean	是否只读。 取值为“true”，只读参数。 取值为“false”，非只读参数。

• 响应示例

  {
    "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
    "name": "paramsGroup-test",
    "description": "",
    "datastore_name": "mongodb",
    "datastore_version": "4.0",
    "created": "2017-01-01T10:00:00",
    "updated": "2017-01-01T10:00:00",
    "parameters": [
      {
        "name": "cursorTimeoutMillis",
        "type": "integer",
        "value": 600000,
        "description": "设置空闲游标的超期时间，DDS将删除空闲的游标",
        "value_range": "600000-1000000",
        "restart_required": false,
        "readonly": false
      }
    ]
  }

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。