创建参数模板

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

我的收藏

1. 接口描述

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

该接口(CreateParamTemplate)用于创建参数模板,全地域公共参数Region均为ap-guangzhou。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateParamTemplate。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。
Name String 参数模板名称。
示例值:test
Description String 参数模板描述。
示例值:""
EngineVersion String MySQL 版本号。
示例值:5.7
TemplateId Integer 源参数模板 ID。
ParamList.N Array of Parameter 参数列表。
TemplateType String 默认参数模板类型。支持值包括:"HIGH_STABILITY" - 高稳定模板,"HIGH_PERFORMANCE" - 高性能模板。
示例值:HIGH_STABILITY
EngineType String 实例引擎类型,默认为"InnoDB",支持值包括:"InnoDB","RocksDB"。
示例值:InnoDB

3. 输出参数

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

4. 示例

示例1 创建参数模板

输入示例

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

{
    "TemplateType": "HIGH_STABILITY",
    "Name": "test",
    "ParamList": [
        {
            "CurrentValue": "MIXED",
            "Name": "binlog_format"
        },
        {
            "CurrentValue": "1",
            "Name": "auto_increment_increment"
        }
    ],
    "EngineVersion": "5.7"
}

输出示例

{
    "Response": {
        "RequestId": "756bb037-a44a-4b4f-abe0-6efd34a6c792",
        "TemplateId": 2333
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
CdbError 后端错误或者流程错误。
CdbError.DatabaseError 后端数据库错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.ParamError 参数错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidName 非法的名称。
InvalidParameterValue.InvalidParameterValueError 参数值无效。