本文汇总缓存数据库 Redis 版提供的 API 接口。
说明
单个地域下，缓存数据库 Redis 版的 API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。
| API | 说明 |
|---|---|
| DescribeRegions | 调用 DescribeRegions 接口查询缓存数据库 Redis 版可用的地域资源列表。 |
| DescribeZones | 调用 DescribeZones 接口查询缓存数据库 Redis 版在指定地域下的可用区资源列表。 |
| API | 说明 |
|---|---|
| CreateDBInstance | 调用 CreateDBInstance 接口创建 Redis 实例。 |
| DescribeDBInstances | 调用 DescribeDBInstances 接口查询 Redis 实例的基本信息。 |
| DescribeDBInstanceDetail | 调用 DescribeDBInstanceDetail 接口查询目标 Redis 实例的详细信息。 |
| DescribeDBInstanceShards | 调用 DescribeDBInstanceShards 接口查询目标 Redis 实例下各 Shard 分片的 Server 节点详情。 |
| DescribeNodeIds | 调用 DescribeNodeIds 接口查询目标 Redis 实例中的所有 Proxy 和 Server 节点 ID 列表。 |
| ModifyDBInstanceName | 调用 ModifyDBInstanceName 接口修改目标 Redis 实例的实例名称。 |
| ModifyDBInstanceDeletionProtectionPolicy | 调用 ModifyDBInstanceDeletionProtectionPolicy 接口开启或关闭目标 Redis 实例的删除保护功能。 |
| ModifyDBInstanceAZConfigure | 调用 ModifyDBInstanceAZConfigure 修改目标 Redis 实例的可用区。 |
| RestartDBInstance | 调用 RestartDBInstance 接口重启目标 Redis 实例。 |
| RestartDBInstanceProxy | 调用 RestartDBInstanceProxy 接口重启目标 Redis 中指定的代理节点。 |
| SwitchOver | 调用 SwitchOver 接口切换目标 Redis 实例的主从节点。 |
| FlushDBInstance | 调用 FlushDBInstance 接口清除目标 Redis 实例中的所有业务数据。 |
| DeleteDBInstance | 调用 DeleteDBInstance 接口删除目标 Redis 实例。 |
| API | 说明 |
|---|---|
| IncreaseDBInstanceNodeNumber | 调用 IncreaseDBInstanceNodeNumber 接口为目标 Redis 实例增加单分片节点数量。 |
| DecreaseDBInstanceNodeNumber | 调用 DecreaseDBInstanceNodeNumber 接口为目标 Redis 实例减少单分片节点数量。 |
| ModifyDBInstanceShardCapacity | 调用 ModifyDBInstanceShardCapacity 修改目标 Redis 实例的单分片内存容量。 |
| ModifyDBInstanceShardNumber | 调用 ModifyDBInstanceShardNumber 接口修改目标 Redis 实例的分片数量。 |
| EnableShardedCluster | 调用 EnableShardedCluster 接口将目标 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 实例。 |
| API | 说明 |
|---|---|
| DescribeDBInstanceParams | 调用 DescribeDBInstanceParams 接口查询目标 Redis 实例支持配置的参数列表。 |
| ModifyDBInstanceParams | 调用 ModifyDBInstanceParams 接口修改目标 Redis 实例的参数配置。 |
| API | 说明 |
|---|---|
| ModifyDBInstanceVpcAuthMode | 调用 ModifyDBInstanceVpcAuthMode 接口开启或关闭目标 Redis 实例的免密访问功能。 |
| ModifyDBInstanceSubnet | 调用 ModifyDBInstanceSubnet 接口将目标 Redis 实例绑定到指定子网。 |
| CreateDBEndpointPublicAddress | 调用 CreateDBEndpointPublicAddress 接口为目标 Redis 实例的创建公网连接地址（即开启实例的公网访问功能）。 |
| DeleteDBEndpointPublicAddress | 调用 DeleteDBEndpointPublicAddress 接口释放目标 Redis 实例的公网连接地址（即关闭公网访问功能）。 |
| ModifyDBInstanceAdditionalBandwidthPerShard | 调用 ModifyDBInstanceAdditionalBandwidthPerShard 接口修改目标 Redis 实例的单分片额外带宽。 |
| ModifyDBInstanceVisitAddress | 调用 ModifyDBInstanceVisitAddress 接口修改目标 Redis 中指定连接地址的域名或端口号。 |
| ModifyDBInstanceMaxConn | 调用 ModifyDBInstanceMaxConn 接口修改目标 Redis 实例的单分片最大连接数。 |
| API | 说明 |
|---|---|
| CreateDBAccount | 调用 CreateDBAccount 接口为目标 Redis 实例创建账号。 |
| ListDBAccount | 调用 ListDBAccount 接口查询 Redis 实例中的账号信息，包括账号名称、账号角色等。 |
| ModifyDBAccount | 调用 ModifyDBAccount 接口修改目标实例中指定账号的信息，包括账号所属角色、密码、描述等。 |
| DeleteDBAccount | 调用 DeleteDBAccount 接口删除目标 Redis 实例中的指定账号。 |
| API | 说明 |
|---|---|
| UpgradeAllowListVersion | 调用 UpgradeAllowListVersion 接口升级目标 Redis 实例的白名单功能。 |
| CreateAllowList | 调用 CreateAllowList 接口创建一个新的 IP 白名单。 |
| DescribeAllowLists | 调用 DescribeAllowLists 接口查询当前账号下指定地域内的 IP 白名单列表。 |
| DescribeAllowListDetail | 调用 DescribeAllowListDetail 接口查询目标白名单的详细信息，包括 IP 地址和绑定的实例详情。 |
| ModifyAllowList | 调用 ModifyAllowList 接口修改目标白名单信息（例如白名单名称、IP 地址、是否设置为默认白名单等）。 |
| AssociateAllowList | 调用 AssociateAllowList 接口将目标 Redis 实例绑定到指定 IP 白名单。 |
| DisassociateAllowList | 调用 DisassociateAllowList 接口将目标 Redis 实例与指定 IP 白名单解绑。 |
| DeleteAllowList | 调用 DeleteAllowList 接口删除目标 IP 白名单。 |
| API | 说明 |
|---|---|
| DescribeSlowLogs | 调用 DescribeSlowLogs 接口查询目标 Redis 实例在指定时间内的慢日志详情。 |
| API | 说明 |
|---|---|
| DescribeBigKeys | 调用 DescribeBigKeys 接口查询目标 Redis 实例在指定时间段内的大 Key 详情。 |