tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstanceAvailabilityZones

Last updated: 2024-04-03 11:33:05

1. API Description

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

This API is used to change the availability zone of the instance.

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: ModifyInstanceAvailabilityZones.
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 Specify the instance ID.
For example: crs-xjhsdj****, please log in to the [Redis Console] (https://console.tencentcloud.com/redis#/) and copy the instance ID from the instance list.
SwitchOption Yes Integer Switch time.
- 1: Switch during the maintenance window.
- 2: Switch immediately.
NodeSet.N Yes Array of RedisNodeInfo Instance node information includes the node ID, node type, and node availability zone ID, and so on. For specific information, please see RedisNodeInfo .
For instances in a single availability zone, there is no need to configure the NodeId. For instances in multiple availability zones, the NodeId is required to configure.

3. Output Parameters

Parameter Name Type Description
TaskId 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 1

This example shows you how to change the availability zones of multiple AZ instances (time window switch).

Input Example

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAvailabilityZones
<Common request parameters>
{
    "InstanceId": "crs-rrhr1lm6",
    "SwitchOption": 1,
    "NodeSet": [
        {
            "NodeId": 339472,
            "NodeType": 0,
            "ZoneId": 100004
        },
        {
            "NodeId": 339473,
            "NodeType": 1,
            "ZoneId": 100003
        },
        {
            "NodeId": 339549,
            "NodeType": 1,
            "ZoneId": 100003
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "27c0d6e8-9894-42e0-a03b-814a204437ba",
        "TaskId": 2031290200
    }
}

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.
InternalError.InternalError Internal error.
InvalidParameter.InvalidParameter Invalid service parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.CheckNotPass Business verification failed
InvalidParameterValue.UnSupportedType The instance type is not supported.
LimitExceeded.ReplicationGroupLocked Replication group locked
ResourceInsufficient The resource is insufficient.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
UnsupportedOperation.InstanceNotOperation Unsupported operation
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy