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

文档中心

缓存数据库 Redis 版

实例管理

SwitchoverBlueGreenDeployment

调用 SwitchoverBlueGreenDeployment 接口为目标 Redis 实例执行蓝绿部署切换。

请求类型

异步请求。

注意事项

仅当源实例下的蓝绿部署状态为可切换（即 Status 为 SWITCHOVER_AVAILABLE）时，才可以执行蓝绿切换操作。关于蓝绿部署状态的更多说明，请参见蓝绿部署状态。
蓝绿切换的操作时长会受到数据写入负载、数据同步链路等因素影响，若切换操作长时间未完成，请提交工单联系技术支持协助定位处理。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
SourceInstanceId	String	是	redis-cn0212gzmh2xs****	源实例（即蓝色实例）的实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
ApplyImmediately	Boolean	是	true	是否立即执行蓝绿切换操作。取值范围如下： `true`：立即切换。 `false`：在可维护时间段内执行切换。说明若选择了在可维护时间段执行，蓝绿部署会进入等待切换状态，且该状态会一直持续到任务完成。关于蓝绿部署状态的更多说明，请参见蓝绿部署状态。可维护时间段的设置方法，请参见设置可维护时间段。

返回参数

参数	类型	示例值	描述
CreateTime	String	2026-01-15 12:57:12	蓝绿部署创建时间，格式为 `yyyy-MM-dd HH:mm:ss`。
DataSyncProgress	Double	99	数据同步进度。
EndTime	String	2026-01-15 14:37:00	蓝绿部署结束时间。格式为 `yyyy-MM-dd HH:mm:ss`。说明仅当蓝绿部署状态为 `DELETE_COMPLETED` 或 `SWITCHOVER_COMPLETED` 时，会返回该字段。
Name	String	upgradeversion	蓝绿部署名称。
SourceEngineVersion	String	5.0	绿色实例的实例名称。
SourceInstanceName	String	upgradeversion	蓝色实例的实例名称。
SourceInstanceId	String	redis-cn0212gzmh2xs****	蓝色实例的实例 ID。
Status	String	SWITCHOVER_AVAILABLE	蓝绿部署状态。关于蓝绿部署状态的更多说明，请参见蓝绿部署状态。
TargetEngineVersion	String	7.0	绿色实例的数据库版本号。
TargetInstanceName	String	redistest-green	绿色实例的实例名称。
TargetInstanceId	String	redis-cn01y2c6v6y6m****	绿色实例的实例 ID。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=SwitchoverBlueGreenDeployment&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.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=****
{
    "SourceInstanceId": "redis-cn0212gzmh2xs****",
    "ApplyImmediately": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "SwitchoverBlueGreenDeployment",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Name": "upgradeversion",
        "Status": "SWITCHOVER_AVAILABLE",
        "EndTime": "2026-01-15 14:37:00",
        "CreateTime": "2026-01-15 12:57:12",
        "DataSyncProgress": 99,
        "SourceInstanceId": "redis-cn0212gzmh2xs****",
        "TargetInstanceId": "redis-cn01y2c6v6y6m****",
        "SourceInstanceName": "upgradeversion",
        "TargetInstanceName": "redistest-green",
        "SourceEngineVersion": "5.0",
        "TargetEngineVersion": "7.0"
    }
}

错误码

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

最近更新时间：2026.06.01 10:44:22

这个页面对您有帮助吗？

有用

无用

缓存数据库 Redis 版

请求类型 #

注意事项 #

调试 #

请求参数 #

返回参数 #

示例 #

请求示例 #

返回示例 #

错误码 #