tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateParamTemplate

Last updated: 2024-01-30 10:25:46

    1. API Description

    Domain name for API request: cdb.tencentcloudapi.com.

    This API is used to create a parameter template. The common request parameter Region can only be set to ap-guangzhou.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: CreateParamTemplate.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    Name Yes String Parameter template name.
    Description No String Parameter template description.
    EngineVersion No String MySQL version number.
    TemplateId No Integer Source parameter template ID.
    ParamList.N No Array of Parameter List of parameters.
    TemplateType No String Type of the default parameter template. Valid values: HIGH_STABILITY (high-stability template), HIGH_PERFORMANCE (high-performance template).
    EngineType No String Instance engine type. Valid values: InnoDB (default), RocksDB.

    3. Output Parameters

    Parameter Name Type Description
    TemplateId Integer Parameter template ID.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a parameter template

    Input Example

    POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateParamTemplate
<Common request parameters>

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

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure CAM signature/authentication error.
    CdbError Backend or process error.
    CdbError.DatabaseError Backend database error.
    InternalError.DatabaseAccessError Internal database error.
    InternalError.ParamError Parameter error
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InvalidName Invalid name.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy