tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

UpgradeVersionToMultiAvailabilityZones

最后更新时间：2024-04-03 11:32:54

    1. API Description

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

    This API is used to upgrade an instance to support multi-AZ deployment.

    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: UpgradeVersionToMultiAvailabilityZones.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID
    UpgradeProxyAndRedisServer No Boolean Whether to support “Reading Local Nodes Only” feature after upgrading to multi-AZ deployment.
    ul>
  • true: The “Read Local Nodes Only” feature is supported. During the upgrade, you need to upgrade the proxy version and Redis kernel minor version simultaneously, which will involve data migration and may take hours to complete.
  • false: The “Read Local Nodes Only” feature is not supported. Upgrading to multi-AZ deployment will involve metadata migration only without affecting the service, which generally take less than three minutes to complete.
    		•

    3. Output Parameters

    Parameter Name Type Description
    FlowId 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 Sample request

    Input Example

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

{
    "InstanceId": "crs-5qlrlhux",
    "UpgradeProxyAndRedisServer": "true"
}

    Output Example

    {
    "Response": {
        "FlowId": "140171780",
        "RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"
    }
}

    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.Unknown Invalid data is entered for weekday.
    InvalidParameter.InvalidParameter Invalid service parameter.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    UnsupportedOperation.InstanceNotOperation Unsupported operation
    UnsupportedOperation.LimitProxyVersion The instance version is too low.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款