缓存数据库 Redis 版
缓存数据库 Redis 版
缓存数据库 Redis 版
文档指南
请输入
产品动态
产品公告
用户指南
实例管理
网络连接管理
参数管理
性能分析
最佳实践
开发参考（控制面）
API 参考
实例管理
变更实例配置
备份恢复
参数管理
连接管理
账号管理
白名单管理
事件管理
性能分析
任务中心
Terraform 参考
开发参考（数据面）
命令支持
常见问题
报错和异常
相关视频
- 文档首页
缓存数据库 Redis 版开发参考（控制面）API 参考事件管理DescribePlannedEventImpactDetail
复制全文
下载 pdfDescribePlannedEventImpactDetail
文档反馈
问问助手调用 DescribePlannedEventImpactDetail 接口查询目标计划内事件的影响信息。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
EventId | String | 是 | event-cq01ojqnj86l**** | 计划内事件的 ID。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Impact | 请参见返回示例。 | 计划内事件的影响。 |
PlannedEventImpactDetail
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
ImpactItem | 请参见返回示例。 | 计划内事件的影响详情。存在节点级影响时返回。 | |
NotGenerated | Boolean | false | 是否已为事件生成影响。取值：
|
ImpactItem
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
AffectedText | String | 该 Proxy 存量连接曾断开（已完成恢复），客户端已重新建立连接 | 节点受到的影响。 |
InvolvedNodes | 请参见返回示例。 | 影响到的节点的详细信息。 | |
UnaffectedText | String | 不在维护列表的Proxy与数据节点连接、读写全程未受影响 | 节点未受影响的说明。 |
SuggestedActions | Array of String | [ "确保客户端连接池配置了自动重连", "重连期间请求可能短暂失败，建议配置重试策略", "后端数据节点无变动，数据读写链路完整", "建议将维护窗口安排在业务低峰期执行" ] | 对计划内事件带来影响的处理建议。 说明 计划内事件未执行时返回，已取消或已成功执行时则不返回。 |
ImpactNode
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Count | Integer | 2 | 受影响的节点数量。 |
NodeIds | Array of String | [ "proxy-0", "proxy-1" ] | 受影响的节点的 ID。 |
RoleName | String | Proxy 节点 | 节点名称，与参数 Type 取值对应：
|
Type | String | ProxyNode | 节点类型。
|
示例
请求示例
POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribePlannedEventImpactDetail&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=****
{
"EventId":"event-cq01ojqnj86l****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribePlannedEventImpactDetail",
"Version": "2020-12-07",
"Service": "Redis",
"Region": "cn-north-1"
},
"Result": {
"Impact": {
"ImpactItem": {
"AffectedText": "该 Proxy 存量连接曾断开（已完成恢复），客户端已重新建立连接",
"InvolvedNodes": [
{
"Count": 2,
"NodeIds": [
"proxy-0",
"proxy-1"
],
"RoleName": "Proxy 节点",
"Type": "ProxyNode"
}
],
"UnaffectedText": "不在维护列表的Proxy与数据节点连接、读写全程未受影响"
},
"NotGenerated": false
}
}
}
错误码
最近更新时间：2026.10.16 14:09:18
这个页面对您有帮助吗？
有用
有用
无用
无用