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

缓存数据库 Redis 版

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

调用 DescribeBlueGreenDeployments 接口查询目标 Redis 实例下的蓝绿部署任务详情。

请求类型

同步请求。

调试

请求参数

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

已创建蓝绿部署任务的蓝色或绿色实例的实例 ID。

说明

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

ExcludeCompleted
Boolean
false

是否查询已处于完成(包括切换完成 SWITCHOVER_COMPLETED和删除完成DELETE_COMPLETED)状态的蓝绿部署任务。取值范围如下:

  • false(默认值):不查询。
  • true:查询。

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeBlueGreenDeployments&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=****
{
    "InstanceId": "redis-cn0212gzmh2xs****",
    "ExcludeCompleted": false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "DescribeBlueGreenDeployments",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "BlueGreenDeployments": [
            {
                "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
这个页面对您有帮助吗?
有用
有用
无用
无用