# 获取参数模板列表-ObtainingParameterTemplates #### 接口说明 获取参数模板列表，包括DDS数据库的所有默认参数模板和用户创建的参数模板。 #### 约束说明 该接口仅支持DDS社区版。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ListConfigurations)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:configuration:listAll | list | - | - | dds:param:list | - | #### URI - URI格式 GET /v3/{project_id}/configurations - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations?offset=0\&limit=100 表1请求参数 | 名称 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---| | X-Auth-Token | String | 是 | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | project_id | String | 是 | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | offset | Integer | 否 | **参数解释：** 索引位置，偏移量。 **约束限制：** 必须为数字。 **取值范围：** 不能为负数。 **默认取值：** 0。偏移0条数据，表示从第一条数据开始查询。 | | limit | Integer | 否 | **参数解释：** 每页显示的数量。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 100。 | #### 请求消息 无。 #### 响应消息 - 参数说明 表3响应Body参数 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | configurations | Array of objects | **参数解释：** 参数模板列表。请参见[表4]。 **取值范围：** 不涉及。 | 表4configurations字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 参数模板ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 参数模板名称。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 参数模板描述。 **取值范围：** 不涉及。 | | datastore_version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及。 | | datastore_name | String | **参数解释：** 数据库类型。 **取值范围：** 不涉及。 | | node_type | String | **参数解释：** 参数模板节点类型。 **取值范围：** - mongos，表示集群mongos节点类型。 - shard，表示集群shard节点类型。 - config，表示集群config节点类型。 - replica，表示副本集类型。 - readonly，表示副本集只读节点类型。 - shard_readonly，表示集群只读节点类型。 - single，表示单节点类型。 | | 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"，表示为用户自定义参数模板。 | - 响应示例 ``` { "total_count" : 1, "configurations" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name" : "test1", "description" : "", "datastore_name" : "mongos", "node_type":"shard", "datastore_version" : "4.0", "created" : "2017-01-01T10:00:00", "updated" : "2017-01-01T10:00:00", "user_defined" : true } ] } ``` #### SDK 单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。