CreateParameterTemplate--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

CreateParameterTemplate

最近更新时间：2025.06.10 11:39:06首次发布时间：2025.06.05 17:21:56

调用 CreateParameterTemplate 接口创建参数模板。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
TemplateName	String	是	参数模板_测试	参数模板的名称。模板名称应满足以下规则：只能包含中文、字母、数字、下划线（_）和中划线（-）。长度为 2~64 个字符。不能以数字或中划线（-）开头。
TemplateType	String	是	PostgreSQL	参数模板的类型。当前取值仅能为 `PostgreSQL`。
TemplateParams	Object[]	是	请参见请求示例。	参数模板中的参数配置。
TemplateTypeVersion	String	是	PostgreSQL_12	兼容版本。取值： `PostgreSQL_11`：PostgreSQL 11。 `PostgreSQL_12`：PostgreSQL 12。 `PostgreSQL_13`：PostgreSQL 13。 `PostgreSQL_14`：PostgreSQL 14。 `PostgreSQL_15`：PostgreSQL 15。 `PostgreSQL_16`：PostgreSQL 16。 `PostgreSQL_17`：PostgreSQL 17。
TemplateDesc	String	否	这是一段参数的描述信息。	模板的描述信息，便于后续模板的应用与管理。最多支持 200 个字符。

返回参数

参数	类型	示例值	描述
TemplateId	String	postgresql-6d57281c3313****	参数模板的 ID。

示例

请求示例

POST /?Action=CreateParameterTemplate&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "TemplateName": "参数模板_测试",
    "TemplateType": "PostgreSQL",
    "TemplateTypeVersion": "PostgreSQL_12",
    "TemplateParams": [
        {
            "Name": "auto_explain.log_analyze",
            "Value": "off"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250507154042DB11BFB3A01D08296D2D-91d4e7",
        "Action": "CreateParameterTemplate",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijijng"
    },
    "Result": {
        "TemplateId": "postgresql-6d57281c3313****"
    }
}