获取参数模板列表 - ObtainingParameterTemplates

功能介绍

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

调用接口前，您需要了解API 认证鉴权。
调用接口前，您需要提前获取到地区和终端节点。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3.2/{project_id}/configurations

表1 参数说明
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
offset	否	Integer	参数解释：索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为0，limit指定为10，则只展示第1~10条数据。约束限制：不涉及。取值范围： [0, 2147483647] 默认取值：默认为0（偏移0条数据，表示从第一条数据开始查询）。
limit	否	Integer	参数解释：查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。约束限制：不涉及。取值范围： [1, 100] 默认取值：默认为100。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
X-Language	否	String	参数解释：指定接口返回信息的语言类型。约束限制：不涉及。取值范围： zh-cn：中文 en-us：英文默认取值： en-us

响应参数

表3 参数说明
参数	参数类型	描述
configurations	Array of objects	参数解释：参数模板信息，具体参数请参考表4。
count	Integer	参数解释：参数模板总记录数。取值范围： [0, 2147483647]，取决于实际查询大小。

表4 configurations字段数据结构说明
参数	参数类型	描述
id	String	参数解释：参数模板ID。参数模板的唯一标识。取值范围：只能由英文字母、数字组成，且长度为36个字符。
name	String	参数解释：参数模板名称。取值范围：参数模板名称在1到64个字符之间，区分大小写，可包含字母、数字、英文中划线、下划线或句点，不能包含其他特殊字符。
description	String	参数解释：参数模板描述。取值范围：描述不能超过256个字符，且不能包含回车和 ! < " = ' > &这些特殊字符。
datastore_version	String	参数解释：引擎版本。取值范围：不涉及。
datastore_name	String	参数解释：引擎名称。取值范围： GaussDB。
ha_mode	String	参数解释：实例类型。取值范围：取值为 "Enterprise"，对应于分布式实例（企业版）。取值为"centralization_standard"，对应于集中式版实例。区分大小写。
created	String	参数解释：创建时间，格式为"yyyy-MM-dd HH:mm:ss"。例如：2024-07-03 14:18:55。取值范围：不涉及。
updated	String	参数解释：更新时间，格式为"yyyy-MM-dd HH:mm:ss"。例如：2024-07-03 14:18:55。取值范围：不涉及。
user_defined	Boolean	参数解释：是否是用户自定义参数模板。取值范围： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。

请求示例

获取参数模板列表。

GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.2/054b61972980d4552f0bc00ac8d3f5cd/configurations?offset=1&limit=3

响应示例

获取参数模板列表成功。

{
    "count": 2,
    "configurations": [
        {
            "id": "079e605c4bb59649c3c9e10d78a55f04pr14",
            "name": "Default-Enterprise-Edition-GaussDB-V2.0-8.218-CNTRL",
            "description": "Default parameter template for Enterprise Edition GaussDB V2.0-8.218-Centralized",
            "created": "2025-08-11 07:45:32",
            "updated": "2025-08-11 07:45:32",
            "datastore_version": "V2.0-8.218",
            "datastore_name": "GaussDB",
            "ha_mode": "centralization_standard",
            "user_defined": false,
            "node_type": "ha"
        },
        {
            "id": "2de186514575471fa758a039b33d1b7fpr14",
            "name": "Default-Enterprise-Edition-GaussDB-V2.0-8.218-INDEP",
            "description": "Default parameter template for Enterprise Edition GaussDB V2.0-8.218-Independent",
            "created": "2025-08-11 07:45:32",
            "updated": "2025-08-11 07:45:32",
            "datastore_version": "V2.0-8.218",
            "datastore_name": "GaussDB",
            "ha_mode": "enterprise",
            "user_defined": false,
            "node_type": "independent"
        }
    ]
}