云原生内存数据库Tair提供丰富的API接口供您使用,本文为您提供API接口的汇总以便查阅。

说明 云原生内存数据库Tair与云数据库Redis版共用API。

生命周期管理

API 描述
DescribeRegions 调用DescribeRegions查询可创建Tair实例的地域。
DescribeZones 调用DescribeZones查询支持Tair的可用区。
DescribeAvailableResource 调用DescribeAvailableResource查询指定可用区内可创建的实例。
CreateInstance 调用CreateInstance创建一个Tair实例。
CreateInstances 调用CreateInstances批量创建Tair实例。
CreateTairInstance 调用CreateTairInstance创建Tair云盘实例。
CreateGlobalDistributeCache 调用CreateGlobalDistributeCache将一个存量的Tair实例转换为分布式实例中第一个子实例。
ModifyInstanceSpec 调用ModifyInstanceSpec变更Tair实例的规格。
AddShardingNode 调用AddShardingNode接口为Tair集群实例添加数据分片节点。
DeleteShardingNode 调用DeleteShardingNode删除Tair集群实例中的数据分片节点。
TransformInstanceChargeType 调用TransformInstanceChargeType接口转换Tair实例的付费类型,支持按量付费和包年包月付费类型之间的相互转换。
TransformToPrePaid 调用TransformToPrePaid将按量付费的Tair实例转换为包年包月(预付费)实例。
DeleteInstance 调用DeleteInstance释放Tair实例。

实例管理

API 描述
DescribeInstances 调用DescribeInstances查询一个或多个Tair实例的信息。
DescribeInstancesOverview 调用DescribeInstancesOverview查询一个或多个Tair实例的信息概览。
DescribeInstanceAttribute 调用DescribeInstanceAttribute查询Tair实例的详细信息。
DescribeGlobalDistributeCache 调用DescribeGlobalDistributeCache查询分布式实例的详细信息。
DescribeEngineVersion 调用DescribeEngineVersion查询Tair实例的大版本和小版本信息。
DescribeRoleZoneInfo 调用DescribeRoleZoneInfo查询Tair实例中各节点的角色、类型、小版本和所属的可用区。
DescribeClusterMemberInfo 调用DescribeClusterMemberInfo接口查询Tair集群实例的节点配置信息(例如规格、最大连接数等)。
DescribeDedicatedClusterInstanceList 调用DescribeDedicatedClusterInstanceList查询专属集群中的Tair实例信息。
DescribeTasks 调用DescribeTasks查询Tair实例某个时间段内运行的所有任务信息。
DescribeDBInstanceNetInfo 调用DescribeDBInstanceNetInfo查看Tair实例的网络信息。
EnableAdditionalBandwidth 调用EnableAdditionalBandwidth调整Tair实例的带宽。
ModifyInstanceAttribute 调用ModifyInstanceAttribute修改Tair实例的属性,包括名称和密码。
ModifyResourceGroup 调用ModifyResourceGroup修改Tair实例所属的资源组。
DescribeLogicInstanceTopology 调用DescribeLogicInstanceTopology查询Tair实例的逻辑拓扑结构。
ModifyInstanceMaintainTime 调用ModifyInstanceMaintainTime修改Tair实例的可维护时间段。
ModifyInstanceMajorVersion 调用ModifyInstanceMajorVersion升级实例的大版本。
ModifyInstanceMinorVersion 调用ModifyInstanceMinorVersion升级Tair实例的小版本。
RestartInstance 调用RestartInstance重启运行中的Tair实例。
FlushExpireKeys 调用FlushExpireKeys清除Tair实例中的过期Key。
SwitchInstanceHA 调用SwitchInstanceHA执行主从切换(即切换节点角色),可应用于容灾演练、多可用区场景下的应用就近连接等需求。
FlushInstance 调用FlushInstance清空Tair实例中的数据,不可恢复。
MigrateToOtherZone 调用MigrateToOtherZone将Tair实例迁移到同地域内的其它可用区。
RemoveSubInstance 调用RemoveSubInstance将子实例从分布式实例中移除并转变为普通Tair实例(数据会被保留)。
SwitchInstanceProxy 调用SwitchInstanceProxy开启或关闭专属集群中Tair集群实例的代理模式。

连接管理

API 描述
SwitchNetwork 调用SwitchNetwork切换Tair实例的网络类型,仅支持从经典网络切换为VPC网络。
ModifyInstanceNetExpireTime Tair实例之前执行过由经典网络向VPC网络切换,并保留了经典网络连接地址,则可调用ModifyInstanceNetExpireTime延长经典网络连接地址的保留时间。
ModifyDBInstanceConnectionString 调用ModifyDBInstanceConnectionString修改Tair实例的连接地址。
AllocateInstancePublicConnection 调用AllocateInstancePublicConnection为Tair实例申请外网连接地址。
ReleaseInstancePublicConnection 调用ReleaseInstancePublicConnection释放Tair实例的外网连接地址。
AllocateDirectConnection 调用AllocateDirectConnection为Tair集群实例申请直连地址。
ReleaseDirectConnection 调用ReleaseDirectConnection释放Tair集群实例的直连地址。
DescribeIntranetAttribute 调用DescribeIntranetAttribute查询Tair实例当前的内网带宽。如果使用了临时调整带宽功能,还可查询临时带宽的过期时间。
ModifyIntranetAttribute 调用ModifyIntranetAttribute临时调整Tair实例的内网带宽。

续费管理

API 描述
DescribePrice 调用DescribePrice查询创建Tair实例、升级配置或续费等操作产生的费用。
RenewInstance 调用RenewInstance为Tair实例续费。
DescribeInstanceAutoRenewalAttribute 调用DescribeInstanceAutoRenewalAttribute查看Tair实例的自动续费情况。
ModifyInstanceAutoRenewalAttribute 调用ModifyInstanceAutoRenewalAttribute开启或者关闭Tair实例的到期前自动续费功能。
RenewAdditionalBandwidth 调用RenewAdditionalBandwidth为购买的Tair实例带宽续费。

账号管理

API 描述
DescribeAccounts 调用DescribeAccounts查找指定Tair实例的账户列表信息或实例中某个账号的信息。
CreateAccount 调用CreateAccount为Tair实例创建有特定权限的账号。
GrantAccountPrivilege 调用GrantAccountPrivilege修改Tair账号的权限。
ModifyAccountDescription 调用ModifyAccountDescription修改Tair账号的描述。
ModifyAccountPassword 调用ModifyAccountPassword接口修改Tair实例中指定账号的密码。
ResetAccountPassword 调用ResetAccountPassword重置Tair账号的密码。
DeleteAccount 调用DeleteAccount删除一个Tair账号。

备份恢复

API 描述
CreateBackup 调用CreateBackup为Tair实例创建数据备份。
DescribeBackupTasks 调用DescribeBackupTasks查询Tair实例的备份任务执行情况。
DescribeBackupPolicy 调用DescribeBackupPolicy查询Tair实例的备份策略,包括备份周期、备份时间等。
ModifyBackupPolicy 调用ModifyBackupPolicy修改Tair实例的自动备份策略。
DescribeBackups 调用DescribeBackups查询Tair实例的备份文件信息。
RestoreInstance 调用RestoreInstance将备份文件中的数据恢复到指定的Tair实例中。

监控管理

API 描述
DescribeMonitorItems 调用DescribeMonitorItems查询Tair监控项列表。
DescribeHistoryMonitorValues 调用DescribeHistoryMonitorValues查看Tair实例的历史监控信息。

日志管理

API 描述
ModifyAuditLogConfig 调用ModifyAuditLogConfig设置Tair实例的审计日志开关与保留时长。
DescribeAuditLogConfig 调用DescribeAuditLogConfig查询Tair实例审计日志是否开启、日志保存时间等配置信息。
DescribeAuditRecords 调用DescribeAuditRecords查看Tair实例的审计日志。
DescribeRunningLogRecords 调用DescribeRunningLogRecords查询Tair实例的运行日志列表。
DescribeSlowLogRecords 调用DescribeSlowLogRecords查询Tair实例在指定时间内产生的慢日志。

网络安全

API 描述
DescribeSecurityIps 调用DescribeSecurityIps查询允许访问Tair实例的IP名单。
ModifySecurityIps 调用ModifySecurityIps设置Tair实例的IP白名单。
DescribeSecurityGroupConfiguration 调用DescribeSecurityGroupConfiguration查看Tair白名单中设置的安全组。
ModifySecurityGroupConfiguration 调用ModifySecurityGroupConfiguration重新设置Tair实例白名单中的安全组。
DescribeInstanceSSL 调用DescribeInstanceSSL查看Tair实例是否开启了SSL加密认证。
ModifyInstanceSSL 调用ModifyInstanceSSL设置Tair实例的SSL加密模式。
ModifyInstanceVpcAuthMode 调用ModifyInstanceVpcAuthMode开启或关闭免密访问。开启免密访问后,同一VPC内的云服务器不使用密码就可以访问Tair,同时仍然支持通过用户名及密码的方式连接Tair

TDE加密

API接口 说明
ModifyInstanceTDE Tair实例开启透明数据加密TDE功能,支持自定义或自动生成密钥。
DescribeInstanceTDEStatus 查询Tair实例是否开启了TDE加密功能。
DescribeEncryptionKeyList 查询Tair实例的TDE加密功能可使用的自定义密钥列表。
DescribeEncryptionKey 查询Tair实例的透明数据加密TDE自定义密钥的详情。
CheckCloudResourceAuthorized 查询Tair实例是否已被授权使用KMS密钥服务。

参数管理

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

标签管理

API 描述
ListTagResources 调用ListTagResources查询绑定了指定标签的Tair实例或者查询指定实例绑定的标签。
TagResources 调用TagResources为一个或多个Tair实例绑定标签。
UntagResources 调用UntagResources将标签从Tair实例解绑。

缓存分析与热点Key查询

API 描述
实时Top Key统计 调用数据库自治服务DAS(Database Autonomy Service)的相关API接口来执行缓存分析任务或查询热点Key。

性能优化

API 描述
CreateCacheAnalysisTask 调用CreateCacheAnalysisTask手动发起离线全量Key分析任务。
DescribeCacheAnalysisReportList 调用DescribeCacheAnalysisReportList查看Tair实例的离线全量Key分析报告列表。
DescribeCacheAnalysisReport 调用DescribeCacheAnalysisReport查看Tair实例在指定日期的离线全量Key分析报告。

运维任务管理

API 描述
DescribeActiveOperationTask 调用DescribeActiveOperationTask查询Tair实例的运维任务详情。
ModifyActiveOperationTask 调用ModifyActiveOperationTask修改运维任务的计划切换时间。