tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateParameterTemplate

Last updated: 2023-10-13 09:42:51

    1. API Description

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

    This API is used to create a parameter template.

    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: CreateParameterTemplate.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    TemplateName Yes String Template name, which can contain 1-60 letters, digits, and symbols (-_./()+=:@).
    DBMajorVersion Yes String The major database version number, such as 11, 12, 13.
    DBEngine Yes String Database engine, such as postgresql, mssql_compatible.
    TemplateDescription No String Parameter template description, which can contain 1-60 letters, digits, and symbols (-_./()+=:@).

    3. Output Parameters

    Parameter Name Type Description
    TemplateId String Parameter template ID, which uniquely identifies a parameter template.
    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

    The database version is PostgreSQL 14, and the engine is postgresql. You can customize the name and description of a parameter template.

    Input Example

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

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

    Output Example

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

    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.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    InvalidParameter.ParameterCheckError Failed to check the parameter.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    OperationDenied.CamDeniedError This operation cannot be performed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy