云数据库 Tair（兼容 Redis®）_API文档-阿里云OpenAPI开发者门户

生命周期管理

OpenAPI 名称	描述	操作

CreateInstance	创建一个Redis开源版或Tair内存型经典版实例。若要创建云原生型的Tair实例，请使用CreateTairInstance接口	查看文档去调试
AddShardingNode	为集群实例添加数据分片节点，本接口仅支持集群架构云原生版实例	查看文档去调试
CreateGlobalDistributeCache	将一个存量的Tair内存型（经典版）实例转换为分布式实例中第一个子实例	查看文档去调试
DescribeRegions	查询云数据库 Tair（兼容 Redis）实例支持的所有地域及其对应可用区信息	查看文档去调试
DescribeZones	查询指定地域下，云数据库 Tair（兼容 Redis）支持的可用区	查看文档去调试
DescribeAvailableResource	查询指定可用区内可创建的实例规格	查看文档去调试
ModifyInstanceSpec	变更云数据库 Tair（兼容 Redis）实例的规格	查看文档去调试
TransformToPrePaid	将按量付费的云数据库 Tair（兼容 Redis）实例转换为包年包月（预付费）实例	查看文档去调试
MigrateToOtherZone	将云数据库 Tair（兼容 Redis）实例迁移到同地域内的其它可用区	查看文档去调试
DeleteShardingNode	删除集群实例中的数据分片节点，本接口仅支持集群架构云原生版实例	查看文档去调试
DeleteInstance	释放云数据库 Tair（兼容 Redis）实例	查看文档去调试

实例管理

OpenAPI 名称	描述	操作

CreateTairInstance	创建云原生版的Tair（企业版）实例	查看文档去调试
CreateInstances	批量创建云数据库 Tair（兼容 Redis）经典版实例	查看文档去调试
DescribeInstancesOverview	查询一个或多个云数据库 Tair（兼容 Redis）实例的信息概览	查看文档去调试
DescribeInstances	查询一个或多个云数据库 Tair（兼容 Redis）实例的信息	查看文档去调试
DescribeDedicatedClusterInstanceList	查询专属集群中的云数据库 Tair（兼容 Redis）实例信息	查看文档去调试
DescribeInstanceAttribute	查询云数据库 Tair（兼容 Redis）实例的详细信息	查看文档去调试
DescribeGlobalDistributeCache	查询分布式实例的详细信息	查看文档去调试
DescribeEngineVersion	查询云数据库 Tair（兼容 Redis）实例的大版本和小版本信息，同时可查询到小版本的发布日志信息	查看文档去调试
DescribeRoleZoneInfo	查询云数据库 Tair（兼容 Redis）实例中各节点的角色、类型、小版本和所属的可用区	查看文档去调试
DescribeClusterMemberInfo	查询云数据库 Tair（兼容 Redis）集群实例的节点配置信息（例如规格、最大连接数等）	查看文档去调试
DescribeTasks	查询云数据库 Tair（兼容 Redis）实例某个时间段内运行的所有任务信息	查看文档去调试
DescribeDBInstanceNetInfo	查看云数据库 Tair（兼容 Redis）实例的网络信息	查看文档去调试
DescribeDBNodeDirectVipInfo	查询集群版直连实例的子实例VIP（Virtual IP Address）信息	查看文档去调试
DescribeLogicInstanceTopology	查询云数据库 Tair（兼容 Redis）实例的逻辑拓扑结构	查看文档去调试
EnableAdditionalBandwidth	调整云数据库 Tair（兼容 Redis）实例的带宽，当前仅支持按量付费的计费方式，您仅需填写InstanceId、NodeId（可选）、Bandwidth、ChargeType参数即可	查看文档去调试
ModifyInstanceAttribute	修改云数据库 Tair（兼容 Redis）实例的部分信息，包括实例密码、名称等	查看文档去调试
ModifyResourceGroup	修改云数据库 Tair（兼容 Redis）实例所属的资源组	查看文档去调试
ModifyInstanceMaintainTime	修改云数据库 Tair（兼容 Redis）实例的可维护时间段，阿里云将在您设定的可维护时间段内对实例进行例行维护	查看文档去调试
ModifyInstanceMajorVersion	升级云数据库 Tair（兼容 Redis）实例的大版本	查看文档去调试
ModifyInstanceMinorVersion	升级云数据库 Tair（兼容 Redis）实例的小版本	查看文档去调试
ModifyDBInstanceAutoUpgrade	修改实例的小版本自动升级开关	查看文档去调试
RestartInstance	重启运行中的云数据库 Tair（兼容 Redis）实例	查看文档去调试
FlushExpireKeys	清除云数据库 Tair（兼容 Redis）实例中的过期Key	查看文档去调试
FlushInstance	清空云数据库 Tair（兼容 Redis）实例中的数据，不可恢复	查看文档去调试
SwitchInstanceHA	执行主从切换（即切换节点角色），可应用于容灾演练、多可用区场景下的应用就近连接等需求	查看文档去调试
SyncDtsStatus	在使用DTS迁移或同步云数据库 Tair（兼容 Redis）实例的数据前，您可以调用本接口限制该实例执行变配操作，避免因变配引起的数据迁移或同步任务失败	查看文档去调试
LockDBInstanceWrite	锁定后，实例将仅支持读取数据，不支持写入	查看文档去调试
UnlockDBInstanceWrite	对写锁定的实例进行解锁，解锁后，实例支持读取、写入数据	查看文档去调试
FlushInstanceForDB	清理云数据库 Tair（兼容 Redis）实例中指定DB的数据	查看文档去调试
RemoveSubInstance	将子实例从分布式实例中移除并转变为普通实例（数据会被保留）	查看文档去调试

连接管理

OpenAPI 名称	描述	操作

AllocateInstancePublicConnection	为云数据库 Tair（兼容 Redis）实例申请公网连接地址	查看文档去调试
AllocateDirectConnection	申请云数据库 Tair（兼容 Redis）集群实例的直连地址	查看文档去调试
DescribeIntranetAttribute	查询云数据库 Tair（兼容 Redis）实例当前的带宽	查看文档去调试
ModifyInstanceNetExpireTime	若云数据库 Tair（兼容 Redis）实例之前执行过由经典网络向VPC网络切换，并保留了经典网络连接地址，则可调用本接口延长经典网络连接地址的保留时间	查看文档去调试
ModifyDBInstanceConnectionString	修改云数据库 Tair（兼容 Redis）实例的连接地址和端口	查看文档去调试
ModifyIntranetAttribute	临时调整专属集群中云数据库 Tair（兼容 Redis）实例的内网带宽	查看文档去调试
SwitchNetwork	切换云数据库 Tair（兼容 Redis）实例的专有网络VPC或交换机，如果实例为经典网络，则会将其切换为专有网络	查看文档去调试
SwitchInstanceProxy	开启或关闭专属集群中云数据库 Tair（兼容 Redis）集群实例的代理模式	查看文档去调试
ReleaseInstancePublicConnection	释放云数据库 Tair（兼容 Redis）实例的公网连接地址	查看文档去调试
ReleaseDirectConnection	释放云数据库 Tair（兼容 Redis）集群实例的直连地址	查看文档去调试

续费管理

OpenAPI 名称	描述	操作

DescribePrice	查询创建、升级配置或续费云数据库 Tair（兼容 Redis）实例等操作产生的费用	查看文档去调试
DescribeInstanceAutoRenewalAttribute	查看云数据库 Tair（兼容 Redis）实例是否开通自动续费	查看文档去调试
ModifyInstanceAutoRenewalAttribute	开启或者关闭云数据库 Tair（兼容 Redis）实例的到期前自动续费功能	查看文档去调试
RenewAdditionalBandwidth	云数据库 Tair（兼容 Redis）实例的带宽已升级为按量付费模式，不再推荐使用本接口	查看文档去调试
TransformInstanceChargeType	转换云数据库 Tair（兼容 Redis）实例的付费类型，支持按量付费和包年包月付费类型之间的相互转换	查看文档去调试
RenewInstance	为包年包月的云数据库 Tair（兼容 Redis）实例续费	查看文档去调试

账号管理

OpenAPI 名称	描述	操作

CreateAccount	创建云数据库 Tair（兼容 Redis）实例的账号	查看文档去调试
DescribeAccounts	查找指定云数据库 Tair（兼容 Redis）实例列表中某个账号的信息	查看文档去调试
ModifyAccountDescription	修改云数据库 Tair（兼容 Redis）实例的账号描述	查看文档去调试
ModifyAccountPassword	修改云数据库 Tair（兼容 Redis）实例中指定账号的密码	查看文档去调试
ResetAccountPassword	重置云数据库 Tair（兼容 Redis）账号的密码	查看文档去调试
GrantAccountPrivilege	修改云数据库 Tair（兼容 Redis）账号的权限	查看文档去调试
DeleteAccount	删除云数据库 Tair（兼容 Redis）实例的账号	查看文档去调试

备份恢复

OpenAPI 名称	描述	操作

CreateBackup	为云数据库 Tair（兼容 Redis）实例创建数据备份	查看文档去调试
RestoreInstance	恢复指定备份文件中的数据到云数据库 Tair（兼容 Redis）实例中	查看文档去调试
DescribeBackupTasks	查询云数据库 Tair（兼容 Redis）实例的备份任务执行情况	查看文档去调试
DescribeBackupPolicy	查询云数据库 Tair（兼容 Redis）实例的备份策略，包括备份周期、备份时间等	查看文档去调试
DescribeBackups	查询云数据库 Tair（兼容 Redis）实例的备份文件信息	查看文档去调试
DescribeClusterBackupList	查询云数据库 Tair（兼容 Redis）集群实例的备份列表	查看文档去调试
ModifyBackupPolicy	修改云数据库 Tair（兼容 Redis）实例的自动备份策略	查看文档去调试

监控管理

OpenAPI 名称	描述	操作

DescribeMonitorItems	查询云数据库 Tair（兼容 Redis）实例支持的监控项列表	查看文档去调试
DescribeHistoryMonitorValues	查看云数据库 Tair（兼容 Redis）实例的性能监控信息	查看文档去调试

日志管理

OpenAPI 名称	描述	操作

DescribeAuditLogConfig	查询云数据库 Tair（兼容 Redis）实例审计日志是否开启、日志保存时间等配置信息	查看文档去调试
DescribeAuditRecords	查询云数据库 Tair（兼容 Redis）实例的审计日志	查看文档去调试
DescribeRunningLogRecords	查询云数据库 Tair（兼容 Redis）实例的运行日志	查看文档去调试
DescribeSlowLogRecords	查询云数据库 Tair（兼容 Redis）实例在指定时间内产生的慢日志	查看文档去调试
ModifyAuditLogConfig	开启或修改云数据库 Tair（兼容 Redis）实例的审计日志设置	查看文档去调试
InitializeKvstorePermission	为云数据库 Tair（兼容 Redis）授权服务关联角色	查看文档去调试

网络安全

OpenAPI 名称	描述	操作

DescribeSecurityIps	查询云数据库 Tair（兼容 Redis）实例的IP白名单	查看文档去调试
DescribeSecurityGroupConfiguration	查看云数据库 Tair（兼容 Redis）白名单中设置的安全组	查看文档去调试
DescribeInstanceSSL	查询云数据库 Tair（兼容 Redis）实例是否开启了TLS（SSL）加密认证	查看文档去调试
ModifySecurityIps	设置云数据库 Tair（兼容 Redis）实例的IP白名单	查看文档去调试
ModifySecurityGroupConfiguration	设置云数据库 Tair（兼容 Redis）实例白名单中的安全组	查看文档去调试
ModifyInstanceSSL	为云数据库 Tair（兼容 Redis）实例开启TLS（Transport Layer Security）加密协议配置	查看文档去调试
ModifyInstanceVpcAuthMode	开启或关闭专有网络免密访问。开启后，同一专有网络内的云服务器无需使用密码即可连接云数据库 Tair（兼容 Redis）实例，同时也继续兼容通过用户名和密码的方式连接实例	查看文档去调试

参数管理

OpenAPI 名称	描述	操作

DescribeParameterTemplates	查询云数据库 Tair（兼容 Redis）实例在不同架构和大版本下的参数列表和默认值	查看文档去调试
DescribeInstanceConfig	查询云数据库 Tair（兼容 Redis）实例的部分默认配置参数信息	查看文档去调试
DescribeParameters	查询云数据库 Tair（兼容 Redis）实例的配置参数和运行参数	查看文档去调试
DescribeParameterModificationHistory	查询云数据库 Tair（兼容 Redis）实例的参数修改历史	查看文档去调试
ModifyInstanceConfig	修改云数据库 Tair（兼容 Redis）实例的参数配置	查看文档去调试

标签管理

OpenAPI 名称	描述	操作

TagResources	为一个或多个云数据库 Tair（兼容 Redis）实例绑定标签	查看文档去调试
ListTagResources	查询云数据库 Tair（兼容 Redis）实例和标签的绑定关系	查看文档去调试
UntagResources	将标签从云数据库 Tair（兼容 Redis）实例解绑	查看文档去调试

性能优化

OpenAPI 名称	描述	操作

CreateCacheAnalysisTask	手动发起实例缓存分析任务	查看文档去调试
DescribeCacheAnalysisReport	查看实例在指定日期中的缓存分析报告	查看文档去调试
DescribeCacheAnalysisReportList	查询实例的缓存分析报告列表	查看文档去调试

数据加密

OpenAPI 名称	描述	操作

DescribeInstanceTDEStatus	查询云数据库 Tair（兼容 Redis）实例是否开启了TDE加密功能	查看文档去调试
DescribeEncryptionKeyList	查询云数据库 Tair（兼容 Redis）实例使用的自定义密钥列表	查看文档去调试
DescribeEncryptionKey	查询云数据库 Tair（兼容 Redis）实例的透明数据加密TDE自定义密钥的详情	查看文档去调试
CheckCloudResourceAuthorized	查询云数据库 Tair（兼容 Redis）实例是否已被授权使用KMS密钥服务	查看文档去调试
ModifyInstanceTDE	为云数据库 Tair（兼容 Redis）实例开启透明数据加密TDE功能，支持自定义密钥	查看文档去调试

运维任务管理

OpenAPI 名称	描述	操作

DescribeHistoryTasks	查看任务中心的任务列表	查看文档去调试
DescribeActiveOperationTask	查询云数据库 Tair（兼容 Redis）实例的运维任务详情	查看文档去调试
ModifyActiveOperationTask	修改运维任务的计划切换时间	查看文档去调试

白名单模板管理

OpenAPI 名称	描述	操作

CreateGlobalSecurityIPGroup	创建全局IP白名单模板	查看文档去调试
DescribeGlobalSecurityIPGroupRelation	查询实例关联的全局IP白名单模板信息	查看文档去调试
DescribeGlobalSecurityIPGroup	查询全局IP白名单模板列表	查看文档去调试
ModifyGlobalSecurityIPGroupName	修改全局IP白名单模板的名称	查看文档去调试
ModifyGlobalSecurityIPGroup	修改全局IP白名单模板	查看文档去调试
ModifyGlobalSecurityIPGroupRelation	将指定实例添加到指定的IP白名单模板中	查看文档去调试
DeleteGlobalSecurityIPGroup	删除全局IP白名单模板	查看文档去调试

参数模板管理

OpenAPI 名称	描述	操作

CreateParameterGroup	创建参数模板	查看文档去调试
DescribeParameterGroupSupportParam	查询在不同版本的参数模版中支持设置的参数列表	查看文档去调试
DescribeParameterGroup	查询参数模版基本信息	查看文档去调试
DescribeParameterGroups	查询可用的参数模版列表	查看文档去调试
DescribeParameterGroupTemplateList	查询参数模板中可配置参数的具体信息，例如默认值、取值范围、描述等	查看文档去调试
ModifyInstanceParameter	将参数模板应用至指定实例，表示将参数模板的值赋于指定的实例中。当您修改参数模版后，您也需要重新应用至指定实例，才能将修改后的参数值赋于指定实例	查看文档去调试
ModifyParameterGroup	修改参数模板的设置	查看文档去调试
DeleteParameterGroup	删除参数模板	查看文档去调试

事件管理

OpenAPI 名称	描述	操作

DescribeActiveOperationTasks	查询实例的运维事件详情	查看文档去调试
ModifyActiveOperationTasks	修改实例计划内运维事件的切换时间	查看文档去调试
CancelActiveOperationTasks	批量取消运维事件	查看文档去调试

故障模拟

OpenAPI 名称	描述	操作

SwitchInstanceZoneFailOver	模拟云数据库 Tair（兼容 Redis）集群架构实例发生可用区级别故障，实例将自动切换到备可用区中	查看文档去调试
MasterNodeShutDownFailOver	模拟云数据库 Tair（兼容 Redis）的指定数据节点或Proxy节点故障，实例将自动进行主备切换，保证高可用	查看文档去调试

其他

OpenAPI 名称	描述	操作

ModifyInstanceBandwidth	设置云数据库 Tair（兼容 Redis）实例的目标带宽值	查看文档去调试
ModifyTaskInfo	进行任务操作，当前支持修改任务执行时间点	查看文档去调试