全部产品
Search
文档中心

云数据库 Redis:API概览

更新时间:Feb 22, 2024
本产品(云数据库 Redis 版/2015-01-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

生命周期管理

API标题API概述
CreateInstance创建一个Redis实例创建一个Redis实例。
AddShardingNode为Redis集群实例添加数据分片节点为Redis集群实例添加数据分片节点。
CreateGlobalDistributeCache将存量实例转换为分布式实例中第一个子实例将一个存量的Redis实例转换为分布式实例中第一个子实例。
DeleteShardingNode删除Redis集群实例中的数据分片节点删除Redis集群实例中的数据分片节点。
DeleteInstance释放Redis实例释放Redis实例。
ModifyInstanceSpec变更Redis实例的规格变更Redis实例的规格。
DescribeRegions查询可用的地域查询可创建Redis实例的地域。
DescribeZones查询支持的可用区查询支持Redis的可用区。
DescribeAvailableResource查询某一可用区的资源列表查询指定可用区内可创建的实例规格。
TransformToPrePaid将按量付费转换为包年包月将按量付费的Redis实例转换为包年包月(预付费)实例。
MigrateToOtherZone迁移实例至其他可用区将Redis实例迁移到同地域内的其它可用区。

实例管理

API标题API概述
CreateTairInstance创建Tair实例创建Tair版实例。
CreateInstances批量创建Redis实例批量创建Redis实例。
EnableAdditionalBandwidth调整实例带宽调整Redis实例的带宽。
ModifyInstanceAttribute修改实例部分信息修改一台实例的部分信息,包括实例密码、名称。
ModifyResourceGroup修改实例所属资源组修改Redis实例所属的资源组。
ModifyInstanceMaintainTime修改可维护时间段修改Redis实例的可维护时间段,阿里云将在您设定的可维护时间段内对Redis实例进行例行维护。
ModifyInstanceMajorVersion升级大版本升级Redis实例的大版本。
ModifyInstanceMinorVersion升级小版本升级Redis实例的小版本。
DescribeInstancesOverview查询实例概览查询一个或多个Redis实例的信息概览。
DescribeInstances查询实例的列表信息查询一个或多个Redis实例的信息。
DescribeInstanceAttribute查询Redis实例的详细信息查询Redis实例的详细信息。
DescribeGlobalDistributeCache查询分布式实例的详细信息查询分布式实例的详细信息。
DescribeEngineVersion查询Redis实例的大版本和小版本信息查询Redis实例的大版本和小版本信息,同时可查询到小版本的发布日志信息。
DescribeRoleZoneInfo查询节点和所属可用区信息查询Redis实例中各节点的角色、类型、小版本和所属的可用区。
DescribeClusterMemberInfo查询集群的节点配置信息查询Redis集群实例的节点配置信息(例如规格、最大连接数等)。
DescribeTasks查询实例某个时间段内所有任务信息查询Redis实例某个时间段内运行的所有任务信息。
DescribeDBInstanceNetInfo查看Redis实例的网络信息查看Redis实例的网络信息。
DescribeLogicInstanceTopology查询Redis实例的逻辑拓扑结构查询Redis实例的逻辑拓扑结构。
RestartInstance重启实例重启运行中的Redis实例。
FlushExpireKeys清除过期Key清除Redis实例中的过期Key。
FlushInstance清空实例中的数据清空Redis实例中的数据,不可恢复。
SwitchInstanceHA切换实例HA执行主从切换(即切换节点角色),可应用于容灾演练、多可用区场景下的应用就近连接等需求。
SyncDtsStatus设置是否限制实例变配在使用DTS迁移或同步Redis实例的数据前,您可以调用SyncDtsStatus可以限制该Redis实例执行变配操作,避免因变配引起的数据迁移或同步任务失败。
RemoveSubInstance将子实例转换为普通实例将子实例从分布式实例中移除并转变为普通Redis实例(数据会被保留)。

连接管理

API标题API概述
ModifyInstanceNetExpireTime延长经典网络地址的保留时间若Redis实例之前执行过由经典网络向VPC网络切换,并保留了经典网络连接地址,则可调用ModifyInstanceNetExpireTime延长经典网络连接地址的保留时间。
ModifyDBInstanceConnectionString修改实例的连接地址和端口修改Redis实例的连接地址和端口。
ModifyIntranetAttribute调整专属集群中Redis实例的内网带宽临时调整专属集群中Redis实例的内网带宽。
DescribeIntranetAttribute查询实例内网带宽信息查询Redis实例当前的内网带宽。如果调整过带宽,您还可以查询到带宽的过期时间。
SwitchNetwork切换专有网络VPC或交换机切换Redis实例的专有网络VPC或交换机,如果Redis实例为经典网络,则会将其切换为专有网络。
AllocateInstancePublicConnection为实例申请公网连接地址为Redis实例申请公网连接地址。
ReleaseInstancePublicConnection释放公网连接地址释放Redis实例的公网连接地址。
AllocateDirectConnection为Redis集群实例申请直连地址为Redis集群实例申请直连地址。
ReleaseDirectConnection释放Redis集群实例的直连地址释放Redis集群实例的直连地址。
SwitchInstanceProxy开启或关闭Redis集群实例的代理模式开启或关闭专属集群中Redis集群实例的代理模式。

续费管理

API标题API概述
ModifyInstanceAutoRenewalAttribute开启或关闭实例自动续费开启或者关闭Redis实例的到期前自动续费功能。
DescribePrice查询价格查询创建Redis实例、升级配置或续费等操作产生的费用。
DescribeInstanceAutoRenewalAttribute查询实例是否开通自动续费查看Redis实例是否开通自动续费。
RenewAdditionalBandwidth带宽续费为购买的Redis实例带宽续费。
TransformInstanceChargeType转换付费类型转换Redis实例的付费类型,支持按量付费和包年包月付费类型之间的相互转换。
RenewInstance手动续费为Redis实例续费。

账号管理

API标题API概述
CreateAccount创建账号可以在Redis实例中创建有特定权限的账号。
DeleteAccount删除账号删除一个Redis账号。
ModifyAccountDescription修改Redis账号的描述修改Redis账号的描述。
ModifyAccountPassword修改账号密码修改Redis实例中指定账号的密码。
DescribeAccounts查找账号信息查找指定Redis实例的帐户列表信息或实例中某个账号的信息。
ResetAccountPassword重置密码重置Redis账号的密码。
GrantAccountPrivilege修改Redis账号的权限修改Redis账号的权限。

备份恢复

API标题API概述
CreateBackup手动备份数据为Redis实例创建数据备份。
ModifyBackupPolicy修改备份策略设置修改Redis实例的自动备份策略。
DescribeBackupTasks查询备份任务执行情况查询Redis实例的备份任务执行情况。
DescribeBackupPolicy查询自动备份策略查询Redis实例的备份策略,包括备份周期、备份时间等。
DescribeBackups查看备份集列表查询Redis实例的备份文件信息。
RestoreInstance恢复数据到指定Redis实例将备份文件中的数据恢复到指定的Redis实例中。

监控管理

API标题API概述
DescribeMonitorItems查询Redis监控项列表查询Redis实例支持的监控项列表。
DescribeHistoryMonitorValues查看Redis实例的性能监控信息查看Redis实例的性能监控信息。

日志管理

API标题API概述
ModifyAuditLogConfig修改审计日志设置修改Redis实例的审计日志设置。
DescribeAuditLogConfig查询审计日志配置查询Redis实例审计日志是否开启、日志保存时间等配置信息。
DescribeAuditRecords查询Redis实例的审计日志查询Redis实例的审计日志。
DescribeRunningLogRecords查询Redis实例的运行日志列表查询Redis实例的运行日志。
DescribeSlowLogRecords查看慢日志明细查询Redis实例在指定时间内产生的慢日志。
InitializeKvstorePermission为Redis授权服务关联角色为云数据库Redis授权服务关联角色。

网络安全

API标题API概述
ModifySecurityIps修改IP白名单设置Redis实例的IP白名单。
ModifySecurityGroupConfiguration重新设置Redis实例白名单中的安全组重新设置Redis实例白名单中的安全组。
ModifyInstanceSSL修改TLS(SSL)配置修改Redis实例SSL配置。
ModifyInstanceVpcAuthMode修改专有网络免密访问设置开启或关闭专有网络免密访问,可在保障安全性的前提下,实现更便捷的数据库连接。
DescribeSecurityIps查询实例的IP白名单查询Redis实例的IP白名单。
DescribeSecurityGroupConfiguration查询已配置的安全组查看Redis白名单中设置的安全组。
DescribeInstanceSSL查询是否开启TLS(SSL)加密查询实例是否开启了TLS(SSL)加密认证。

参数管理

API标题API概述
ModifyInstanceConfig修改Redis实例的参数配置修改Redis实例的参数配置。
DescribeParameterTemplates查询参数列表和默认值查询Redis实例在不同架构和大版本下的参数列表和默认值。
DescribeInstanceConfig查询实例参数配置查询Redis实例的参数配置信息。
DescribeParameters查询Redis实例的配置参数和运行参数查询Redis实例的配置参数和运行参数。
DescribeParameterModificationHistory查询参数修改历史查询Tair或Redis实例的参数修改历史。

标签管理

API标题API概述
ListTagResources查询标签列表查询Redis实例和标签的绑定关系。
TagResources为一个或多个Redis实例绑定标签为一个或多个Redis实例绑定标签。
UntagResources为实例解绑标签将标签从Redis实例解绑。

性能优化

API标题API概述
CreateCacheAnalysisTask创建缓存分析任务手动发起Redis缓存分析任务。
DescribeCacheAnalysisReport查看实例缓存分析报告查看Redis实例在指定日期中的缓存分析报告。
DescribeCacheAnalysisReportList查询Redis实例的缓存分析报告列表查询Redis实例的缓存分析报告列表。

数据加密

API标题API概述
ModifyInstanceTDE开启透明数据加密TDE为Redis实例开启透明数据加密TDE功能,支持自定义密钥。
DescribeInstanceTDEStatus查询实例是否开启TDE加密查询Redis实例是否开启了TDE加密功能。
DescribeEncryptionKeyList查询实例的自定义密钥列表查询Redis使用的自定义密钥列表。
DescribeEncryptionKey查询实例的TDE自定义密钥详情查询Redis实例的透明数据加密TDE自定义密钥的详情。
CheckCloudResourceAuthorized查询是否已授权KMS密钥查询Redis实例是否已被授权使用KMS密钥服务。

运维任务管理

API标题API概述
ModifyActiveOperationTask修改运维任务的计划切换时间修改运维任务的计划切换时间。
DescribeActiveOperationTask查询运维任务详情查询Redis实例的运维任务详情。

白名单模板管理

API标题API概述
CreateGlobalSecurityIPGroup创建IP白名单模板创建全局IP白名单模板。
ModifyGlobalSecurityIPGroupName修改IP白名单模板名称修改全局IP白名单模板的名称。
DescribeGlobalSecurityIPGroupRelation查询实例关联的IP白名单模板信息查询实例关联的全局IP白名单模板信息。
DeleteGlobalSecurityIPGroup删除IP白名单模板删除全局IP白名单模板。
ModifyGlobalSecurityIPGroup修改IP白名单模板修改全局IP白名单模板。
ModifyGlobalSecurityIPGroupRelation将实例添加到IP白名单模板中将指定实例添加到指定的IP白名单模板中。
DescribeGlobalSecurityIPGroup查询IP白名单模板列表查询全局IP白名单模板列表。

其他

API标题API概述
DescribeDedicatedClusterInstanceList查看专属集群实例的列表查询专属集群中的Redis实例信息。
DescribeHistoryTasks查询历史运维任务查看任务中心的任务列表。
FlushInstanceForDB清理实例指定DB的数据清理实例中指定DB的数据。
ModifyInstanceParameter应用参数模板到实例将参数模板应用到指定实例。
UnlockDBInstanceWrite解锁实例写锁定操作对写锁定的实例进行解锁,解锁后,实例支持读取、写入数据。
LockDBInstanceWrite锁定实例写操作锁定后,实例将仅支持读取数据,不支持写入。
DescribeClusterBackupList查询集群实例的备份列表查看Redis、Tair集群实例的备份列表。
DescribeDBNodeDirectVipInfo查询直连实例子实例的 vip查询集群版直连实例的子实例vip信息。