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

缓存数据库 Redis 版

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

调用 CreateBlueGreenDeployment 接口为目标 Redis 实例创建蓝绿部署任务。

请求类型

异步请求。

注意事项

  • 一个实例每次最多允许存在一个正在进行的蓝绿部署进程。更多详情,请参见通过蓝绿部署升级大版本
  • 通过蓝绿部署升级大版本的实例需同时满足如下要求:
    • 实例的数据库版本不为 Redis 7.0。
    • 实例状态需为运行中。关于实例状态的更多详情,请参见实例状态
    • 实例未使用额外带宽。若已使用需先取消额外带宽。具体操作步骤,请参见修改带宽
    • 启用分片集群实例未申请直连地址。若已申请需先释放直连地址。具体操作步骤,请参见释放直连地址
  • 当前仅支持创建按量计费的绿色实例,因此创建绿色实例前,需确保您的账户余额(即现金余额)和代金券的总值不得小于 100 元人民币。更多详情,请参见按量计费

调试

请求参数

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

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

说明

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

Name
String
upgradeversion
蓝绿部署任务的描述。
TargetInstanceName
String
redistest-green

设置目标实例(即绿色实例)的名称。名称需同时满足如下要求:

  • 不能以数字、中划线(-)开头。
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。
  • 长度需为 1~128 个字符。

说明

  • 若不设置绿色实例的名称,则默认以<蓝色实例名称>-green-<六位随机码>作为绿色实例的实例名称。
    例如,蓝色实例名称为 redistest,那么为该实例创建绿色实例时,绿色实例的默认名称可能为 redistest-green-b4bf10
  • 缓存数据库 Redis 版实例名称的长度不能超过 128 个字符,而 -green-<六位随机码> 会占用固定的 13 个字符。因此,绿色实例名称中 <蓝色实例名称>部分最多只保留蓝色名称的前 115 个字符来适配总长度限制。
TargetEngineVersion
String
7.0

设置绿色实例的数据库版本。

说明

绿色实例的数据库版本必须大于蓝色实例的数据库版本。例如,蓝色实例的数据库版本为 5.0,那么绿色实例的数据库版本可以为 6.0 或 7.0。

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=CreateBlueGreenDeployment&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****",
    "Name": "upgradeversion",
    "TargetInstanceName": "redistest-green",
    "TargetEngineVersion": "7.0"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "CreateBlueGreenDeployment",
        "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:57:24
这个页面对您有帮助吗?
有用
有用
无用
无用