# 获取参数模板列表 - ObtainingParameterTemplates #### 功能介绍 获取参数模板列表，包括所有数据库的默认参数模板和用户创建的参数模板。 ![](https://support.huaweicloud.com/api-nosql/public_sys-resources/notice_3.0-zh-cn.png) 该接口计划下线，建议及时切换到新接口[获取参数模板列表 - ObtainingParameterTemplates](https://support.huaweicloud.com/api-nosql/nosql_06_0002.html)。 #### 接口约束 该接口支持如下数据库实例： - GeminiDB Cassandra - GeminiDB Mongo - GeminiDB Influx - GeminiDB Redis #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ListConfigurations)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:configuration:list | List | - | - | nosql:param:list | - | #### URI - URI格式 GET /v3/{project_id}/configurations - URI样例 https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations - 参数说明 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | datastore_name | 否 | String | **参数解释：** 数据库名称。 **约束限制：** 不涉及。 **取值范围：** cassandra：表示支持GeminiDB Cassandra实例。 redis：表示支持GeminiDB Redis实例。 influxdb：表示支持GeminiDB Influx实例。 mongodb： 表示支持GeminiDB Mongo实例。 **默认取值：** 不传该参数，则表示查询所有数据库类型。 | | mode | 否 | String | **参数解释：** 数据库实例类型。 **约束限制：** 不涉及。 **取值范围：** - 取值为"CloudNativeCluster", 表示查询支持GeminiDB Cassandra云原生部署模式实例的参数模板。 - 取值为"Cluster", 表示查询GeminiDB Cassandra经典部署模式集群、GeminiDB Influx经典部署模式集群、GeminiDB Redis Proxy集群经典部署模式集群实例支持的参数模板。 - 取值为"InfluxdbSingle", 表示查询支持GeminiDB Influx经典部署模式单节点类型实例的参数模板。 - 取值为"ReplicaSet", 表示查询支持GeminiDB Mongo副本集类型实例的参数组。 - 取值为"All"， 表示查询所有部署模式的参数模板。 **默认取值：** 不传该参数，则表示查询经典部署模式实例支持的参数组。 | #### 请求消息 无。 #### 响应消息 - 正常响应要素说明 表3要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | configurations | Array of [表4] objects | **参数解释：** 参数模板列表。 | 表4configurations字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释：** 参数模板ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 参数模板名称。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 参数模板描述。 **取值范围：** 不涉及。 | | datastore_version_name | 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：表示为用户自定义参数模板。 | - 正常响应样例 ``` { "count": 2, "configurations": [{ "id": "887ea0d1bb0843c49e8d8e5a09a95652pr06", "name": "configuration_test", "description": "configuration_test", "datastore_version_name": "3.11", "datastore_name": "cassandra", "created": "2019-05-15T11:53:34+0000", "updated": "2019-05-15T11:53:34+0000", "user_defined": true }, { "id": "3bc1e9cc0d34404b9225ed7a58fb284epr06", "name": "Default-Cassandra-3.11", "description": "Default parameter group for cassandra 3.11", "datastore_version_name": "3.11", "datastore_name": "cassandra", "created": "2020-03-21T03:38:51+0000", "updated": "2019-03-21T03:38:51+0000", "user_defined": false } ] } ``` - 异常响应 请参见[异常请求结果](https://support.huaweicloud.com/api-nosql/nosql_abnormal_result.html)。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。