API 列表--缓存数据库 Redis 企业版-火山引擎

文档中心

导航

API 列表

最近更新时间：2024.12.16 10:30:06首次发布时间：2024.11.20 10:29:38

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

说明

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

地域和可用区

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

实例管理

API	说明
CreateEnterpriseDBInstance	调用 CreateEnterpriseDBInstance 创建 Redis 企业版实例。
DescribeDBInstances	调用 DescribeDBInstances 接口查询 Redis 企业版实例的基本信息。
DescribeEnterpriseDBInstanceDetail	调用 DescribeEnterpriseDBInstanceDetail 接口查询目标 Redis 企业版的实例详情。
ModifyEnterpriseDBInstanceCapacity	调用 ModifyEnterpriseDBInstanceCapacity 接口修改目标 Redis 企业版实例配置，例如分片数、单分片容量等。
DeleteEnterpriseDBInstance	调用 DeleteEnterpriseDBInstance 接口删除目标 Redis 企业版实例。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改目标 Redis 企业版实例的实例名称。
ModifyDBInstanceDeletionProtectionPolicy	调用 ModifyDBInstanceDeletionProtectionPolicy 接口开启或关闭目标 Redis 企业版实例的删除保护功能。

标签管理

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

备份恢复

API	说明
CreateBackup	调用 CreateBackup 接口为目标 Redis 企业版实例手动创建备份。
DescribeBackups	调用 DescribeBackups 接口查询目标 Redis 企业版实例的备份集列表。
DescribeBackupPlan	调用 DescribeBackupPlan 接口查询目标 Redis 企业版实例的自动备份策略，包括备份类型、备份周期、下一次执行备份的预期时间等信息。
ModifyBackupPlan	调用 ModifyBackupPlan 修改目标 Redis 企业版实例的自动备份策略，包括开始执行备份时间段、开启或关闭自动备份等设置。
DescribeBackupPointDownloadUrls	调用 DescribeBackupPointDownloadUrls 接口查询目标 Redis 企业版实例中指定备份文件的下载地址。
RestoreDBInstance	调用 RestoreDBInstance 接口将备份集中的数据恢复到原 Redis 企业版实例。

连接管理

API	说明
CreateDBEndpointPublicAddress	调用 CreateDBEndpointPublicAddress 接口为目标 Redis 企业版实例的创建公网连接地址（即开启实例的公网访问功能）。
DeleteDBEndpointPublicAddress	调用 DeleteDBEndpointPublicAddress 接口释放目标 Redis 企业版实例的公网连接地址（即关闭公网访问功能）。

账号管理

API	说明
CreateDBAccount	调用 CreateDBAccount 接口为目标 Redis 企业版实例创建账号。
ListDBAccount	调用 ListDBAccount 接口查询 Redis 企业版实例中的账号信息，包括账号名称、账号角色等。
ModifyDBAccount	调用 ModifyDBAccount 接口修改目标 Redis 企业版实例中指定账号的信息，包括账号所属角色、密码、描述等。
DeleteDBAccount	调用 DeleteDBAccount 接口删除目标 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 白名单。

参数管理

API	说明
DescribeEnterpriseDBInstanceParams	调用 DescribeEnterpriseDBInstanceParams 接口查询目标 Redis 企业版实例支持的参数列表。
ModifyEnterpriseDBInstanceParams	调用 ModifyEnterpriseDBInstanceParams 接口修改目标 Redis 企业版实例的参数配置。