Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
128 lines (99 sloc) 10.2 KB

API概览 {#doc_3170 .concept}

云数据库 Redis 版提供以下相关API接口。

生命周期管理 {#section_wnc_4ph_gxs .section}

API 描述
DescribeAvailableResource 调用DescribeAvailableResource查询指定可用区内可创建的实例。
CreateInstance 调用CreateInstance创建一个Redis实例。
ModifyInstanceSpec 调用ModifyInstanceSpec变更Redis实例的规格。
TransformToPrePaid 调用TransformToPrePaid将按量付费的Redis实例转换为包年包月(预付费)实例。
DeleteInstance 调用DeleteInstance释放Redis实例。

区域管理 {#section_nne_l2y_9fr .section}

API 描述
MigrateToOtherZone 调用MigrateToOtherZone将Redis实例迁移到同地域内的其它可用区。
DescribeRegions 调用DescribeRegions查询可创建Redis实例的地域。
DescribeZones 调用DescribeZones查询支持Redis的可用区。

连接管理 {#section_7sr_b7z_is7 .section}

API 描述
AllocateInstancePublicConnection 调用AllocateInstancePublicConnection为Redis实例申请外网连接地址。
ReleaseInstancePublicConnection 调用ReleaseInstancePublicConnection释放Redis实例的外网连接地址。
ModifyIntranetAttribute 调用ModifyIntranetAttribute临时调整Redis实例的内网带宽。
DescribeIntranetAttribute 调用DescribeIntranetAttribute查询Redis实例当前的内网带宽。如果使用了临时调整带宽功能,还可查询临时带宽的过期时间。

实例管理 {#section_lfn_lwx_cij .section}

API 描述
DescribeDBInstanceNetInfo 调用DescribeDBInstanceNetInfo查看Redis实例的网络信息。
DescribeInstanceAttribute 调用DescribeInstanceAttribute查询Redis实例的详细信息。
DescribeInstances 调用DescribeInstances查询一个或多个Redis实例的信息。
DescribeLogicInstanceTopology 调用DescribeLogicInstanceTopology查询Redis实例的逻辑拓扑结构。
FlushInstance 调用FlushInstance清空Redis实例中的数据,不可恢复。
ModifyInstanceAttribute 调用ModifyInstanceAttribute修改Redis实例的属性,包括名称和密码。
ModifyInstanceMaintainTime 调用ModifyInstanceMaintainTime修改Redis实例的可维护时间段,阿里云将在您设定的可维护时间段内对Redis实例进行例行维护。
ModifyInstanceNetExpireTime 若Redis实例之前执行过由经典网络向VPC网络切换,并保留了经典网络连接地址,则可调用ModifyInstanceNetExpireTime延长经典网络连接地址的保存时间。
ModifyDBInstanceConnectionString 调用ModifyDBInstanceConnectionString修改Redis实例的连接地址。
SwitchNetwork 调用SwitchNetwork切换Redis实例的网络类型,支持从经典网络切换为VPC网络。
ModifyInstanceMajorVersion 调用ModifyInstanceMajorVersion升级Redis实例的大版本。
ModifyInstanceMinorVersion 调用ModifyInstanceMinorVersion升级Redis实例的小版本。
RestartInstance 调用RestartInstance重启运行中的Redis实例。

续费管理 {#section_846_9pp_u4o .section}

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

账号管理 {#section_udx_s4f_mdh .section}

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

备份恢复 {#section_mep_bs3_vjn .section}

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

监控管理 {#section_3ho_eyn_3hx .section}

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

日志管理 {#section_tsv_mpe_wsd .section}

API 描述
DescribeAuditRecords 调用DescribeAuditRecords查看Redis实例的审计日志。
DescribeRunningLogRecords 调用DescribeRunningLogRecords查询Redis实例的运行日志列表。
DescribeSlowLogRecords 调用DescribeSlowLogRecords查询Redis实例在指定时间内产生的慢日志。
ModifyAuditLogConfig 调用ModifyAuditLogConfig设置审计日志的保留天数。

网络安全 {#section_ueg_nnx_toe .section}

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

参数管理 {#section_cbw_fi4_dby .section}

API 描述
ModifyInstanceConfig 调用ModifyInstanceConfig修改Redis实例的配置参数。
DescribeParameters 调用DescribeParameters查询Redis实例的配置参数和运行参数。

标签管理 {#section_f3l_jr1_sql .section}

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

性能优化 {#section_rxf_zmj_eds .section}

API 描述
CreateCacheAnalysisTask 调用CreateCacheAnalysisTask手动发起缓存分析任务。
DescribeCacheAnalysisReport 调用DescribeCacheAnalysisReport查看Redis实例在指定日期中的缓存分析报告。
DescribeCacheAnalysisReportList 调用DescribeCacheAnalysisReportList查看Redis实例的缓存分析报告列表。
You can’t perform that action at this time.