You need to enable JavaScript to run this app.
导航
ModifyDBInstanceAZConfigure
最近更新时间:2024.02.07 12:41:51首次发布时间:2023.05.26 12:28:08

调用 ModifyDBInstanceAZConfigure 修改指定 Redis 实例的可用区。

请求类型

异步请求。

注意事项

  • 修改可用区过程中,实例可能会出现 1~2 次连接闪断(每次闪断时长在 30 秒内)或 10 秒左右的不可读写,请谨慎操作,并确保客户端配置了正确的重试机制。
  • 修改可用区所需时间会受多种因素(如网络环境、任务队列、数据量大小等)影响,建议在业务低峰期执行操作。
  • 不支持将单节点实例从单可用区迁移至多可用区。
  • 需将单可用区主备实例的读写分离参数先设置为 read_secondary_nodes_only ,才可迁移至多可用区。您可以调用 ModifyDBInstanceParams 接口修改指定实例的读写分离参数。

请求参数

名称类型是否必选示例值描述

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

ApplyImmediately

Boolean

true

是否立即执行配置变更操作。取值范围如下:

  • true:立即变更。
  • false:在可维护时间段内执行变更。关于可维护时间段的更多信息,请参见设置可维护时间段

MultiAZ

String

disabled

设置实例的可用区部署方案。取值范围如下:

ConfigureNodes

Array of ConfigureNodeInfo

[{
"AZ": "cn-beijing-a"
}, {
"AZ": "cn-beijing-b"
}]

设置节点所属的可用区。实例的可用区部署方案会影响当前参数的填写情况,其中:

  • MultiAZ 取值为 enabled(即使用多可用区部署方案)时:传入的可用区数量需等于当前实例单分片包含的节点数,且第一个可用区即为主节点所在的可用区。
    例如,当前实例每分片包含 3 个节点,您需要为每个节点传入对应的可用区信息。
  • MultiAZ 取值为 disabled(即使用单可用区部署方案)时:仅需传入一个可用区即可,实例中所有节点均会部署在该可用区。

说明

  • 您可以调用 DescribeZones 接口查询目标地域下的可用区信息,包括可用区 ID。
  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括是否设置了多可用区部署方案。

CreateBackup

Boolean

true

是否在变更前创建全量备份。取值范围如下:

  • true:创建备份。
  • false(默认值):不创建备份。

说明

  • 该参数仅对主备实例(即 InstanceClassPrimarySecondary)生效。单节点实例(即 InstanceClassStandalone) 不支持备份功能,因此该参数不会对单节点实例生效。
  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括实例类型。

BackupPointName

String

b-cn02xmmrp751i9cdzcphjmk4****

为变更前创建的全量备份设置备份名称。若不设置备份名称,默认使用备份 ID 作为名称。
如需设置备份名称,名称需同时满足如下条件:

  • 以中文、字母、下划线(_)开头。
  • 长度为 1-128 个字符。
  • 由中文、字母、数字、下划线(_)和中划线(-)组成。

说明

仅当选择了需要在变更前创建备份(即 CreateBackuptrue)时,该参数生效。

ClientTokenStringWbiAlPqJM6tMoSOYhT****用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回数据

名称类型示例值描述
OrderNOString无示例值修改可用区不涉及实例订单相关操作,因此该参数返回值会为空。

请求示例

  • 从单可用区迁移至单可用区,修改可用区前后实例配置如下表所示。

    实例配置修改可用区前修改可用区后
    可用区部署方案单可用区单可用区
    单分片节点数22
    节点所在可用区主从节点均在可用区 A主从节点均在可用区 B
    POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceAZConfigure&Version=2020-12-07 HTTP/1.1
    Host: redis.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK*/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=*
    {
            "InstanceId": "redis-cn0212gzmh2xs****",
            "ApplyImmediately": true,
            "MultiAZ": "disabled",
            "ConfigureNodes": [
    		        {
                    "AZ": "cn-beijing-b"
                }
            ],
            "CreateBackup": true
    }
    
  • 从多可用区迁移至多可用区,修改可用区前后实例配置如下表所示。

    实例配置修改可用区前修改可用区后
    可用区部署方案多可用区多可用区
    单分片节点数22

    节点所在可用区

    • 主节点:可用区 A

    • 从节点:可用区 B

    • 主节点:可用区 B

    • 从节点:可用区 C

    POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceAZConfigure&Version=2020-12-07 HTTP/1.1
    Host: redis.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK*/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=*
    {
            "InstanceId": "redis-cn0212gzmh2xs****",
            "ApplyImmediately": true,
            "MultiAZ": "enabled",
            "ConfigureNodes": [
    		        {
                    "AZ": "cn-beijing-b"
                },
                {
                    "AZ": "cn-beijing-c"
    		        }
    		    ],
            "CreateBackup": true
    }
    
  • 从单可用区迁移至多可用区,修改可用区前后实例配置如下表所示。

    实例配置修改可用区前修改可用区后
    可用区部署方案单可用区多可用区
    单分片节点数22

    节点所在可用区

    主从节点均在可用区 A

    • 主节点:可用区 B

    • 从节点:可用区 C

    POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceAZConfigure&Version=2020-12-07 HTTP/1.1
    Host: redis.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK*/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=*
    {
            "InstanceId": "redis-cn0212gzmh2xs****",
            "ApplyImmediately": true,
            "MultiAZ": "enabled",
            "ConfigureNodes": [
    		        {
                    "AZ": "cn-beijing-b"
                },
                {
                    "AZ": "cn-beijing-c"
    		        }
    		    ],
            "CreateBackup": true
    }
    
  • 从多可用区迁移至单可用区,修改可用区前后实例配置如下表所示。

    实例配置修改可用区前修改可用区后
    可用区部署方案多可用区单可用区
    单分片节点数22

    节点所在可用区

    • 主节点:可用区 B

    • 从节点:可用区 C

    主从节点均在可用区 A

    POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceAZConfigure&Version=2020-12-07 HTTP/1.1
    Host: redis.volcengineapi.com
    Content-Type: application/json; charset=utf-8
    X-Date: 20201103T104027Z
    Authorization: HMAC-SHA256 Credential=AK*/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=*
    {
            "InstanceId": "redis-cn0212gzmh2xs****",
            "ApplyImmediately": true,
            "MultiAZ": "disabled",
            "ConfigureNodes": [
    		        {
                    "AZ": "cn-beijing-b"
                }
            ],
            "CreateBackup": true
    }
    

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230522150300E9F5BEC3072CC0BE****",
        "Action": "ModifyDBInstanceAZConfigure",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderNO": ""
    }
}

错误码

更多详情,请参见错误码