创建参数模板

最近更新时间:2024-03-12 01:44:18

我的收藏

1. 接口描述

接口请求域名: postgres.tencentcloudapi.com 。

本接口 (CreateParameterTemplate) 用于创建参数模板。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateParameterTemplate。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
TemplateName String 模板名称,长度为1~60个字符,仅支持数字,英文大小写字母、中文以及特殊字符-./()()[]+=::@
示例值:test
template
DBMajorVersion String 数据库大版本号,例如:11,12,13
示例值:13
DBEngine String 数据库引擎,例如:postgresql,mssql_compatible
示例值:postgresql
TemplateDescription String 参数模板描述,长度为0~60个字符,仅支持数字,英文大小写字母、中文以及特殊字符_-./()()[]+=::@
示例值:test

3. 输出参数

参数名称 类型 描述
TemplateId String 参数模板ID,用于唯一确认参数模板
示例值:497857b4-4676-5583-8359-b697fe5968d9
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建参数模板示例

数据库版本为14,引擎为postgresql,参数模板名称和描述自定义。

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateParameterTemplate
<公共请求参数>

{
    "TemplateName": "test_template",
    "DBMajorVersion": "13",
    "DBEngine": "postgresql",
    "TemplateDescription": "test"
}

输出示例

{
    "Response": {
        "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
        "TemplateId": "497857b4-4676-5583-8359-b697fe5968d9"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DatabaseAccessError 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.FailedOperationError 操作失败,请稍后重试。
InvalidParameter.ParameterCheckError 参数检查失败。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
OperationDenied.CamDeniedError 当前操作被限制。