获取参数模板列表

功能介绍

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

接口约束

无

调试

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

URI

URL格式

GET /v3/{project_id}/configurations?offset={offset}&limit={limit}

参数说明

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一region下的project ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0。取值必须为数字，且不能为负数。
limit	否	Integer	查询个数上限值。取值范围：1~128。不传该参数时，默认值为10。

请求参数

无。

请求示例

获取DDM参数模板列表。

GET https://{endpoint}/v3/project_id/configurations?offset=0&limit=10

响应消息

正常响应参数说明

表3 响应Body参数
参数	参数类型	描述
configurations	Array of ConfigurationInfo objects	引擎信息列表。
offset	Integer	分页参数: 起始值。
limit	Integer	分页参数：每页多少条。
total	Integer	引擎信息总数。

表4 ConfigurationInfo
参数	参数类型	描述
id	String	参数模板ID。
name	String	参数模板名称。
description	String	参数模板描述。
datastore_name	String	数据库类型。
created	String	创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
updated	String	更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
user_defined	Boolean	是否是用户自定义参数模板： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。

正常响应示例

{
  "configurations": [
    {
      "id": "2aa71dc81e2c47699229b7aa26038f9dpr09",
      "name": "ddm-param1724812533",
      "description": "",
      "datastore_name": "ddm",
      "created": "2021-12-14T07:46:22+0000",
      "updated": "2021-12-14T07:46:22+0000",
      "user_defined": false
    }
  ],
  "offset": 0,
  "limit": 10,
  "total": 1
}