You need to enable JavaScript to run this app.
导航
API 概览
最近更新时间:2024.05.10 10:17:07首次发布时间:2021.11.15 16:07:16

本文汇总缓存数据库 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 接口查询指定实例下各 Shard 分片的 Server 节点详情。
DescribeNodeIds调用 DescribeNodeIds 接口查看指定 Redis 实例包含的所有 Proxy 和 Server 节点 ID 信息。
ModifyDBInstanceName调用 ModifyDBInstanceName 接口修改实例名称。
RestartDBInstance调用 RestartDBInstance 接口重启指定的 Redis 实例。
ModifyDBInstanceDeletionProtectionPolicy调用 ModifyDBInstanceDeletionProtectionPolicy 接口开启或关闭实例删除保护功能。
DeleteDBInstance调用 DeleteDBInstance 接口删除指定的 Redis 实例。
ModifyDBInstanceAZConfigure调用 ModifyDBInstanceAZConfigure 接口修改指定实例的可用区。
SwitchOver调用 SwitchOver 接口为指定实例执行主从节点切换。
RestartDBInstanceProxy调用 RestartDBInstanceProxy 接口重启一个或多个代理节点(Proxy Node)。
FlushDBInstance调用 FlushDBInstance 接口清除指定实例中的所有业务数据。

变更实例配置

API描述
IncreaseDBInstanceNodeNumber调用 IncreaseDBInstanceNodeNumber 接口增加指定实例的单分片节点数量。
DecreaseDBInstanceNodeNumber调用 DecreaseDBInstanceNodeNumber 接口减少指定实例的单分片节点数量。
ModifyDBInstanceShardCapacity调用 ModifyDBInstanceShardCapacity 变更指定实例的单分片内存容量。
ModifyDBInstanceShardNumber调用 ModifyDBInstanceShardNumber 接口变更指定实例的分片数量。
EnableShardedCluster调用 EnableShardedCluster 接口变更将指定未启用分片集群实例变更为启用分片集群实例。

标签管理

API描述
AddTagsToResource调用 AddTagsToResource 接口为指定实例绑定标签。
RemoveTagsFromResource调用 RemoveTagsFromResource 接口为指定实例解绑标签。
DescribeTagsByResource调用 DescribeTagsByResource 接口查询实例已绑定的标签信息。

计费管理

API描述
ModifyDBInstanceChargeType调用 ModifyDBInstanceChargeType 接口修改目标实例的计费类型。

备份恢复

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

参数管理

API描述
DescribeDBInstanceParams调用 DescribeDBInstanceParams 接口查询指定 Redis 实例的配置参数信息。
ModifyDBInstanceParams调用 ModifyDBInstanceParams 接口修改指定 Redis 实例的配置参数。

连接管理

API描述
ModifyDBInstanceVpcAuthMode调用 ModifyDBInstanceVpcAuthMode 接口开启或关闭免密访问功能。
ModifyDBInstanceSubnet调用 ModifyDBInstanceSubnet 接口修改指定 Redis 实例的子网。
CreateDBEndpointPublicAddress调用 ModifyDBInstanceSubnet 接口为指定 Redis 实例的创建公网连接地址(即开启公网访问功能)。
DeleteDBEndpointPublicAddress调用 DeleteDBEndpointPublicAddress 接口删除指定 Redis 实例的公网连接地址(即关闭公网访问功能)。
ModifyDBInstanceAdditionalBandwidthPerShard调用 ModifyDBInstanceAdditionalBandwidthPerShard 接口修改指定实例的单分片带宽。
ModifyDBInstanceVisitAddress调用 ModifyDBInstanceVisitAddress 接口修改指定连接地址的域名或端口号。

账号管理

API描述
CreateDBAccount调用 CreateDBAccount 接口为指定 Redis 实例创建账号。
ListDBAccount调用 ListDBAccount 接口查询 Redis 实例中指定账号或所有账号的信息,包括账号名称、账号角色等。
ModifyDBAccount调用 ModifyDBAccount 接口修改指定账号的信息,包括账号所属角色、密码、描述等。
DeleteDBAccount调用 DeleteDBAccount 接口删除指定账号。

白名单管理

API描述
UpgradeAllowListVersion调用 UpgradeAllowListVersion 接口升级目标 Redis 实例的白名单功能。
CreateAllowList调用 CreateAllowList 接口创建一个新的 IP 白名单。
DescribeAllowLists调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息。
DescribeAllowListDetail调用 DescribeAllowListDetail 接口查询目标白名单的详细信息,包括 IP 地址和绑定的实例详情。
ModifyAllowList调用 ModifyAllowList 接口修改目标白名单(例如白名单名称、IP 白名单地址等)。
AssociateAllowList调用 AssociateAllowList 接口将目标实例绑定到指定 IP 白名单中。
DisassociateAllowList调用 DisassociateAllowList 接口将目标实例从指定 IP 白名单中解绑。
DeleteAllowList调用 DeleteAllowList 接口删除目标白名单。

日志管理

API描述
DescribeSlowLogs调用 DescribeSlowLogs 接口查看目标实例在指定时间段内的慢日志详情。

性能分析

API描述
DescribeBigKeys调用 DescribeBigKeys 接口查看目标实例在指定时间段内的大 Key 详情。