文档中心

缓存数据库 Redis 版

API 参考

API 列表

本文汇总缓存数据库 Redis 版提供的 API 接口。

说明

单个地域下，缓存数据库 Redis 版的 API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。

地域和可用区

API	说明
DescribeRegions	调用 DescribeRegions 接口查询缓存数据库 Redis 版可用的地域资源列表。
DescribeZones	调用 DescribeZones 接口查询缓存数据库 Redis 版在指定地域下的可用区资源列表。

实例管理

API	说明
CreateDBInstance	调用 CreateDBInstance 接口创建 Redis 实例。
DescribeDBInstanceSpecs	调用 DescribeDBInstanceSpecs 接口查询 Redis 支持的实例规格列表。
DescribeDBInstances	调用 DescribeDBInstances 接口查询 Redis 实例的基本信息。
DescribeDBInstanceDetail	调用 DescribeDBInstanceDetail 接口查询目标 Redis 实例的详细信息。
DescribeDBInstanceShards	调用 DescribeDBInstanceShards 接口查询目标 Redis 实例下各 Shard 分片的 Server 节点详情。
DescribeNodeIds	调用 DescribeNodeIds 接口查询目标 Redis 实例中的所有 Proxy 和 Server 节点 ID 列表。
DescribeDBInstanceSlots	调用 DescribeDBInstanceSlots 接口查询目标 Redis 实例下各分片的槽位（Slot）分配情况。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改目标 Redis 实例的实例名称。
ModifyDBInstanceDeletionProtectionPolicy	调用 ModifyDBInstanceDeletionProtectionPolicy 接口开启或关闭目标 Redis 实例的删除保护功能。
ModifyDBInstanceAZConfigure	调用 ModifyDBInstanceAZConfigure 修改目标 Redis 实例的可用区。
ModifyMaintenanceTime	调用 ModifyMaintenanceTime 接口修改目标 Redis 实例的可维护时间段。
RestartDBInstance	调用 RestartDBInstance 接口重启目标 Redis 实例。
RestartDBInstanceProxy	调用 RestartDBInstanceProxy 接口重启目标 Redis 实例中指定的代理节点。
SwitchOver	调用 SwitchOver 接口切换目标 Redis 实例的主从节点。
FlushDBInstance	调用 FlushDBInstance 接口清除目标 Redis 实例中的所有业务数据。
DeleteDBInstance	调用 DeleteDBInstance 接口删除目标 Redis 实例。
DescribeDBEngineVersions	调用 DescribeDBEngineVersions 接口查询 Redis 数据库大版本所支持的小版本列表。
ModifyDBInstanceMinorVersion	调用 ModifyDBInstanceMinorVersion 接口将目标 Redis 实例升级到指定小版本。
CreateBlueGreenDeployment	调用 CreateBlueGreenDeployment 接口为目标 Redis 实例创建蓝绿部署任务。
DescribeBlueGreenDeployments	调用 DescribeBlueGreenDeployments 接口查询目标 Redis 实例下的蓝绿部署任务详情。
SwitchoverBlueGreenDeployment	调用 SwitchoverBlueGreenDeployment 接口为目标 Redis 实例执行蓝绿部署切换。
DeleteBlueGreenDeployment	调用 DeleteBlueGreenDeployment 接口为目标 Redis 实例取消蓝绿部署任务。

变更实例配置

API	说明
IncreaseDBInstanceNodeNumber	调用 IncreaseDBInstanceNodeNumber 接口为目标 Redis 实例增加单分片节点数量。
DecreaseDBInstanceNodeNumber	调用 DecreaseDBInstanceNodeNumber 接口为目标 Redis 实例减少单分片节点数量。
ModifyDBInstanceShardCapacity	调用 ModifyDBInstanceShardCapacity 修改目标 Redis 实例的单分片内存容量。
ModifyDBInstanceShardNumber	调用 ModifyDBInstanceShardNumber 接口修改目标 Redis 实例的分片数量。
EnableShardedCluster	调用 EnableShardedCluster 接口将目标 Redis 实例变更为启用分片集群实例。
EnableDBInstanceHA	调用 EnableDBInstanceHA 接口将 Redis 单节点实例变更为主备实例。

标签管理

API	说明
AddTagsToResource	调用 AddTagsToResource 接口为目标 Redis 实例绑定标签。
DescribeTagsByResource	调用 DescribeTagsByResource 接口查询目标 Redis 实例已绑定的标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口为目标 Redis 实例解绑标签。

计费管理

API	说明
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口修改目标 Redis 实例的计费类型。

备份恢复

API	说明
CreateBackup	调用 CreateBackup 接口为目标 Redis 实例手动创建备份。
DescribeBackups	调用 DescribeBackups 接口查询目标 Redis 实例的备份集列表。
DescribeBackupPlan	调用 DescribeBackupPlan 接口查询目标 Redis 实例的自动备份策略，包括备份类型、备份周期、下一次执行备份的预期时间等信息。
ModifyBackupPlan	调用 ModifyBackupPlan 修改目标 Redis 实例的自动备份策略，包括开始执行备份时间段、开启或关闭自动备份等设置。
DescribePitrTimeWindow	调用 DescribePitrTimeWindow 接口查询目标 Redis 实例通过按时间点恢复数据时所支持的可恢复时间段。
DescribeBackupPointDownloadUrls	调用 DescribeBackupPointDownloadUrls 接口查询目标 Redis 实例中指定备份文件的下载地址。
StartContinuousBackup	调用 StartContinuousBackup 接口开启目标 Redis 实例的数据闪回功能。
StopContinuousBackup	调用 StopContinuousBackup 接口关闭目标 Redis 实例的数据闪回功能。
RestoreDBInstance	调用 RestoreDBInstance 接口将备份集中的数据恢复到原 Redis 实例。
DescribeAvailableCrossRegion	调用 DescribeAvailableCrossRegion 接口查询目标 Redis 实例中可作为跨地域备份目的地域列表。
DescribeCrossRegionBackupPolicy	调用 DescribeCrossRegionBackupPolicy 接口查询目标 Redis 实例的跨地域备份策略。
ModifyCrossRegionBackupPolicy	调用 ModifyCrossRegionBackupPolicy 接口修改目标 Redis 实例的跨地域备份策略。
DescribeCrossRegionBackups	调用 DescribeCrossRegionBackups 接口查询跨地域备份文件列表。

参数管理

API	说明
DescribeDBInstanceParams	调用 DescribeDBInstanceParams 接口查询目标 Redis 实例支持的参数列表。
ModifyDBInstanceParams	调用 ModifyDBInstanceParams 接口修改目标 Redis 实例的参数配置。
CreateParameterGroup	调用 CreateParameterGroup 接口创建参数模板。
DescribeParameterGroups	调用 DescribeParameterGroups 接口查询当前账号和地域下的参数模板的基本信息。
DescribeParameterGroupDetail	调用 DescribeParameterGroupDetail 接口查询目标参数模板的详细信息。
ModifyParameterGroup	调用 ModifyParameterGroup 接口修改参数模板信息（例如参数模板名称、描述、模板中的参数值等）。
ApplyParameterGroup	调用 ApplyParameterGroup 接口将参数模板应用到实例。
DeleteParameterGroup	调用 DeleteParameterGroup 接口删除目标参数模板。

连接管理

API	说明
ModifyDBInstanceVpcAuthMode	调用 ModifyDBInstanceVpcAuthMode 接口开启或关闭目标 Redis 实例的免密访问功能。
ModifyDBInstanceSubnet	调用 ModifyDBInstanceSubnet 接口修改目标 Redis 实例的私有网络或子网信息。
CreateDBEndpointPublicAddress	调用 CreateDBEndpointPublicAddress 接口为目标 Redis 实例创建公网连接地址（即开启实例的公网访问功能）。
DeleteDBEndpointPublicAddress	调用 DeleteDBEndpointPublicAddress 接口释放目标 Redis 实例的公网连接地址（即关闭公网访问功能）。
CreateDBEndpointDirectLinkAddress	调用 CreateDBEndpointDirectLinkAddress 接口为目标 Redis 实例申请直连地址。
DeleteDBEndpointDirectLinkAddress	调用 DeleteDBEndpointDirectLinkAddress 接口为目标 Redis 实例释放直连地址。
DescribeDBInstanceBandwidthPerShard	调用 DescribeDBInstanceBandwidthPerShard 接口查询目标 Redis 的单分片带宽详情，包括默认带宽和额外带宽。
ModifyDBInstanceAdditionalBandwidthPerShard	调用 ModifyDBInstanceAdditionalBandwidthPerShard 接口修改目标 Redis 实例的单分片额外带宽。
ModifyDBInstanceVisitAddress	调用 ModifyDBInstanceVisitAddress 接口修改目标 Redis 中指定连接地址的域名或端口号。
ModifyDBInstanceMaxConn	调用 ModifyDBInstanceMaxConn 接口修改目标 Redis 实例的单分片最大连接数。
ModifyDBInstancePrivateDNSVisibility	调用 ModifyDBEndpointPrivateDNSVisibility 接口为目标 Redis 实例开启或关闭公网解析功能。

账号管理

API	说明
CreateDBAccount	调用 CreateDBAccount 接口为目标 Redis 实例创建账号。
ListDBAccount	调用 ListDBAccount 接口查询 Redis 实例中的账号信息，包括账号名称、账号角色等。
ModifyDBAccount	调用 ModifyDBAccount 接口修改目标 Redis 实例中指定账号的信息，包括账号所属角色、密码、描述等。
DeleteDBAccount	调用 DeleteDBAccount 接口删除目标 Redis 实例中的指定账号。
DescribeDBInstanceAclCommands	调用 DescribeDBInstanceAclCommands 接口查询目标 Redis 实例中指定命令类别支持的命令列表。
DescribeDBInstanceAclCategories	调用 DescribeDBInstanceAclCategories 接口查询目标 Redis 实例支持的命令类别。

白名单管理

API	说明
CreateAllowList	调用 CreateAllowList 接口创建一个新的 IP 白名单。
DescribeAllowLists	调用 DescribeAllowLists 接口查询当前账号下在指定地域的 IP 白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查询目标白名单的详细信息，包括 IP 地址和绑定的实例详情。
ModifyAllowList	调用 ModifyAllowList 接口修改目标白名单信息（例如白名单名称、IP 地址、是否设置为默认白名单等）。
AssociateAllowList	调用 AssociateAllowList 接口将目标 Redis 实例绑定到指定 IP 白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口将目标 Redis 实例与指定 IP 白名单解绑。
DeleteAllowList	调用 DeleteAllowList 接口删除目标 IP 白名单。
SyncAllowList	调用 SyncAllowList 接口同步白名单中绑定的安全组的 IP 地址。

日志管理

API	说明
DescribeSlowLogs	调用 DescribeSlowLogs 接口查询目标 Redis 实例在指定时间内的慢日志详情。
DescribeFatLogs	调用 DescribeFatLogs 接口查询目标 Redis 实例在指定时间内的 Server 节点或 Proxy 节点的 Fatlog 日志详情。

事件管理

API	说明
DescribePlannedEvents	调用 DescribePlannedEvents 接口查询目标 Redis 实例在指定时间段的计划内事件。
ModifyPlannedEventExecuteTime	调用 ModifyPlannedEventExecuteTime 接口修改计划内系统运维事件的执行时间。
ExecutePlannedEvent	调用 ExecutePlannedEvent 接口立即执行计划内事件。

性能分析

API	说明
DescribeBigKeys	调用 DescribeBigKeys 接口查询目标 Redis 实例在指定时间段内的大 Key 详情。
DescribeHotKeys	调用 DescribeHotKeys 接口查询目标 Redis 实例在指定时间段内的热 Key 详情。
CreateKeyScanJob	调用 CreateKeyScanJob 接口为目标 Redis 实例创建过期 key 扫描任务。
DescribeKeyScanJobs	调用 DescribeKeyScanJobs 接口查询目标 Redis 实例在指定时间段内的过期 key 清除任务列表。
InterruptKeyScanJob	调用 InterruptKeyScanJob 接口取消指定的过期 key 清除任务。
DescribeClientSessionSnapshot	调用 DescribeClientSessionSnapshot 接口查询实例在指定时间窗口内的客户端会话快照。
DeleteAllClientSession	调用 DeleteAllClientSession 接口终止目标 Redis 实例中的所有会话。

故障演练

API	说明
TestFailoverDBInstanceZone	调用 TestFailoverDBInstanceZone 接口为目标 Redis 实例模拟可用区级别故障切换。
TestShutDownDBInstanceNodes	调用 TestShutDownDBInstanceNodes 接口为目标 Redis 实例模拟指定 Server 或 Proxy 节点故障切换。

任务中心

API	说明
DescribeTasks	调用 DescribeTasks 查询任务。

最近更新时间：2026.07.23 11:50:33

这个页面对您有帮助吗？

有用

无用