tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ModifyParameterTemplate

最后更新时间：2024-06-17 14:26:04

    1. API Description

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

    This API is used to modify the configurations, such as parameter template name and description. It can also be used to manage the parameter list in the 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: ModifyParameterTemplate.
    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.
    TemplateId Yes String Parameter template ID, which uniquely identifies a parameter template and cannot be modified.
    TemplateName No String Parameter template name, which can contain 1-60 letters, digits, and symbols (-_./()+=:@). If this field is empty, the original parameter template name will be used.
    TemplateDescription No String Parameter template description, which can contain 1-60 letters, digits, and symbols (-_./()+=:@). If this parameter is not passed in, the original parameter template description will be used.
    ModifyParamEntrySet.N No Array of ParamEntry The set of parameters to be modified or added. A parameter cannot be put to ModifyParamEntrySet and DeleteParamSet at the same time, that is, it cannot be modified/added and deleted at the same time.
    DeleteParamSet.N No Array of String The set of parameters to be deleted in the template. A parameter cannot be put to ModifyParamEntrySet and DeleteParamSet at the same time, that is, it cannot be modified/added and deleted at the same time.

    3. Output Parameters

    Parameter Name Type Description
    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 Modifying a parameter template

    None

    Input Example

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

{
    "TemplateId": "497857b4-4676-5583-8359-b697fe5968d9",
    "TemplateName": "test_template",
    "TemplateDescription": "test",
    "ModifyParamEntrySet": [
        {
            "Name": "max_wal_senders",
            "ExpectedValue": "360"
        },
        {
            "Name": "max_logical_replication_workers",
            "ExpectedValue": "360"
        }
    ],
    "DeleteParamSet": [
        "wal_level"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90"
    }
}

    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.FailedOperationError Operation failed. Please try again later.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    OperationDenied.CamDeniedError This operation cannot be performed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款