tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ApplyParamsTemplate

Last updated: 2024-12-04 11:18:51

    1. API Description

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

    This API is used to apply parameter templates to instances.

    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: ApplyParamsTemplate.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceIds.N Yes Array of String Instance ID list. Log in to the Redis console and copy the instance ID in the instance list.
    TemplateId Yes String ID of the applied parameter template, which can be obtained through the response parameter TemplateId of the API DescribeParamTemplateInfo.

    3. Output Parameters

    Parameter Name Type Description
    TaskIds Array of Integer Task 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 Modifying instance parameters

    Input Example

    https://redis.intl.tencentcloudapi.com/?Action=ApplyParamsTemplate
&InstanceIds.0=crs-5a4py64p
&TemplateId=crs-cfg-rhlppeye
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TaskIds": [
            212,
            213,
            214
        ],
        "RequestId": "e546784b-709c-401d-aba6-73037eb4e522"
    }
}

    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.SystemError Internal system error, which is irrelevant to the business.
    FailedOperation.UnSupportError The instance does not support this API.
    InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
    InternalError.InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    ResourceUnavailable.CallOssError Failed to call the backend API.
    ResourceUnavailable.InstanceConfError An instance configuration error occurred.
    ResourceUnavailable.InstanceLockedError Redis has been locked by another process.
    ResourceUnavailable.InstanceStateError Instance status error.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.NoCAMAuthed No CAM permissions.
    UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy