tencent cloud

CreateParamTemplate
Download PDF
Last updated: 2025-11-13 20:51:07
CreateParamTemplate
Last updated: 2025-11-13 20:51:07
Download PDF

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to create parameter templates.

A maximum of 20 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: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
TemplateName Yes String Template name
EngineVersion Yes String MySQL version number
TemplateDescription No String Template description
TemplateId No Integer ID of the template to be copied
DbMode No String Database type. Valid values: NORMAL (default), SERVERLESS.
ParamList.N No Array of ParamItem List of the parameters

3. Output Parameters

Parameter Name Type Description
TemplateId Integer Template ID
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Create a Parameter Template

This example shows you how to create a parameter template.

Input Example

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

{
"TemplateDescription": "Common template"
    "EngineVersion": "5.7",
    "TemplateId": 93,
"TemplateName": "Common Parameter Template for 5.7"
}

Output Example

{
    "Response": {
        "RequestId": "b7735dc6-5847-4c9b-a713-9745f9afda34",
        "TemplateId": 95
    }
}

Example2 Custom Parameter Template

Creating a custom parameter template

Input Example

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

{
"TemplateDescription": "API testing"
    "EngineVersion": "5.7",
    "TemplateId": 100,
    "DbMode": "NORMAL",
"TemplateName": "API Testing"
}

Output Example

{
    "Response": {
        "RequestId": "edbd6b65-daf0-4ca8-b34f-cc3fd42790d8",
        "TemplateId": 27
    }
}

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
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.UnknownError Unknown internal error.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
OperationDenied.CamDeniedError Failed to verify permissions
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback