ModifyDBInstanceAZConfigure--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceAZConfigure

最近更新时间：2024.07.18 22:55:09首次发布时间：2023.05.26 12:28:08

调用 ModifyDBInstanceAZConfigure 修改目标 Redis 实例的可用区。

请求类型

异步请求。

注意事项

修改可用区过程中，实例可能会出现 1~2 次连接闪断（每次闪断时长在 30 秒内）或 10 秒左右的不可读写，请谨慎操作，并确保客户端配置了正确的重试机制。
修改可用区所需时间会受多种因素（如网络环境、任务队列、数据量大小等）影响，建议在业务低峰期执行操作。
不支持将单节点实例从单可用区迁移至多可用区。更多详情，请参见修改可用区。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
ApplyImmediately	Boolean	是	true	是否立即执行配置变更操作。取值范围如下： `true`：立即变更。 `false`：在可维护时间段内执行变更。关于可维护时间段的更多信息，请参见设置可维护时间段。
MultiAZ	String	是	disabled	设置实例的可用区部署方案。取值范围如下： `enabled`：多可用区部署方案。 `disabled`：单可用区部署方案。关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。
ConfigureNodes	Object[]	是		设置节点所属的可用区列表。
CreateBackup	Boolean	否	true	是否在变更前创建全量备份。取值范围如下： `true`：创建备份。 `false`（默认值）：不创建备份。说明该参数仅对主备实例（即 `InstanceClass` 取值为 `PrimarySecondary`）生效。单节点实例（即 `InstanceClass` 取值为 `Standalone`）不支持备份功能，因此该参数不会对单节点实例生效。您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息，包括实例类型。
BackupPointName	String	否	b-cn02xmmrp751i9cdzcphjmk4****	为变更前创建的全量备份设置备份名称。若不设置备份名称，默认使用备份 ID 作为名称。如需设置备份名称，名称需同时满足如下条件: 以中文、字母、下划线（_）开头。长度为 1-128 个字符。由中文、字母、数字、下划线（_）和中划线（-）组成。说明仅当选择了需要在变更前创建备份（即 `CreateBackup` 为 `true`）时，该参数生效。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例 1

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

实例配置	修改可用区前	修改可用区后
可用区部署方案	单可用区	单可用区
单分片节点数	2	2
节点所在可用区	主从节点均在可用区 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
}

返回示例 1

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

请求示例 2

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

实例配置	修改可用区前	修改可用区后
可用区部署方案	多可用区	多可用区
单分片节点数	2	2
节点所在可用区	主节点：可用区 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
}

返回示例 2

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

请求示例 3

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

实例配置	修改可用区前	修改可用区后
可用区部署方案	单可用区	多可用区
单分片节点数	2	2
节点所在可用区	主从节点均在可用区 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
}

返回示例 3

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

请求示例 4

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

实例配置	修改可用区前	修改可用区后
可用区部署方案	多可用区	单可用区
单分片节点数	2	2
节点所在可用区	主节点：可用区 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-a"
        }],
        "CreateBackup": true
}

返回示例 4

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

错误码

更多详情，请参见错误码。