You need to enable JavaScript to run this app.
文档中心
缓存数据库 Redis 版

缓存数据库 Redis 版

复制全文
下载 pdf
实例管理
SwitchoverBlueGreenDeployment
复制全文
下载 pdf
SwitchoverBlueGreenDeployment

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

请求类型

异步请求。

注意事项

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

调试

请求参数

参数
类型
是否必选
示例值
描述
SourceInstanceId
String
redis-cn0212gzmh2xs****

源实例(即蓝色实例)的实例 ID。

说明

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

ApplyImmediately
Boolean
true

是否立即执行蓝绿切换操作。取值范围如下:

  • true:立即切换。
  • false:在可维护时间段内执行切换。

说明

若选择了在可维护时间段执行,蓝绿部署会进入等待切换状态,且该状态会一直持续到任务完成。关于蓝绿部署状态的更多说明,请参见蓝绿部署状态。可维护时间段的设置方法,请参见设置可维护时间段

返回参数

参数
类型
示例值
描述
BlueGreenDeployment
Object
蓝绿部署信息列表。

示例

请求示例

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": {
        "BlueGreenDeployment": {
            "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.05.29 12:43:40
这个页面对您有帮助吗?
有用
有用
无用
无用