The following tables describe API operations available for use in ApsaraDB for Redis.

Lifecycle management

API Description
DescribeRegions Queries the regions where ApsaraDB for Redis instances can be deployed.
DescribeZones Queries the zones where ApsaraDB for Redis instances can be deployed.
DescribeAvailableResource Queries the types of instances that can be created in specified zones.
CreateInstance Creates an ApsaraDB for Redis instance.
ModifyInstanceSpec Changes the type of an ApsaraDB for Redis instance.
TransformToPrePaid Changes the billing method of an ApsaraDB for Redis instance from pay-as-you-go to subscription.
DeleteInstance Releases an ApsaraDB for Redis instance.

Instance management

API Description
DescribeInstances Queries information about one or more ApsaraDB for Redis instances.
DescribeInstanceAttribute Queries detailed information about an ApsaraDB for Redis instance.
DescribeEngineVersion Queries detailed information about the major version and minor version of an ApsaraDB for Redis instance.
DescribeRoleZoneInfo Queries information about the roles, type, and minor version of specific nodes in an ApsaraDB for Redis instance, and zones where the instance is deployed.
DescribeTasks Queries all tasks that are performed by an ApsaraDB for Redis instance within a specified period.
DescribeDBInstanceNetInfo Queries network information about an ApsaraDB for Redis instance.
ModifyInstanceAttribute Modifies the attributes of an ApsaraDB for Redis instance, such as the name and password.
ModifyResourceGroup Modifies the resource group to which an ApsaraDB for Redis instance belongs.
DescribeLogicInstanceTopology Queries the logical topology of an ApsaraDB for Redis instance.
ModifyInstanceMaintainTime Modifies the maintenance window of an ApsaraDB for Redis instance.
ModifyInstanceMajorVersion Upgrades the major version of an ApsaraDB for Redis instance.
ModifyInstanceMinorVersion Upgrades the minor version of an ApsaraDB for Redis instance.
RestartInstance Restarts a running ApsaraDB for Redis instance.
FlushExpireKeys Deletes expired keys of an ApsaraDB for Redis instance.
FlushInstance Clears data of an ApsaraDB for Redis instance. The cleared data cannot be restored.
MigrateToOtherZone Migrates an ApsaraDB for Redis instance to another zone in the same region.

Connection management

API Description
SwitchNetwork Switches the network type of an ApsaraDB for Redis instance from classic network to Virtual Private Cloud (VPC).
ModifyInstanceNetExpireTime Prolongs the retention period of the endpoint of the classic network when the network type of an ApsaraDB for Redis instance is switched from classic network to VPC.
ModifyDBInstanceConnectionString Modifies an endpoint of an ApsaraDB for Redis instance.
AllocateInstancePublicConnection Applies for a public endpoint of an ApsaraDB for Redis instance.
ReleaseInstancePublicConnection Releases a public endpoint of an ApsaraDB for Redis instance.
AllocateDirectConnection Applies for a private endpoint of an ApsaraDB for Redis instance.
ReleaseDirectConnection Releases a private endpoint of an ApsaraDB for Redis instance.
DescribeIntranetAttribute Queries the current maximum internal bandwidth of an ApsaraDB for Redis instance. If you have adjusted the maximum internal bandwidth for a short period, this operation also returns the expiration time of the temporary maximum internal bandwidth.
ModifyIntranetAttribute Adjusts the maximum internal bandwidth of an ApsaraDB for Redis instance for a short period.

Renewal management

API Description
DescribePrice Queries the fees to create, update, and renew ApsaraDB for Redis instances.
RenewInstance Renews an ApsaraDB for Redis instance.
DescribeInstanceAutoRenewalAttribute Queries the auto-renewal status of one or more ApsaraDB for Redis instances.
ModifyInstanceAutoRenewalAttribute Enables or disables auto-renewal for ApsaraDB for Redis instances.

Account management

API Description
DescribeAccounts Queries all accounts or a specified account of an ApsaraDB for Redis instance.
CreateAccount Creates an account that has specified permissions on an ApsaraDB for Redis instance.
GrantAccountPrivilege Modifies the permissions for an account of an ApsaraDB for Redis instance.
ModifyAccountDescription Modifies the description of an account of an ApsaraDB for Redis instance.
ModifyAccountPassword Modifies the password of an account of an ApsaraDB for Redis instance.
ResetAccountPassword Resets the password of an account of an ApsaraDB for Redis instance.
DeleteAccount Deletes an account of an ApsaraDB for Redis instance.

Backup and restoration

API Description
CreateBackup Backs up an ApsaraDB for Redis instance.
DescribeBackupPolicy Queries the backup policy of an ApsaraDB for Redis instance, such as the backup cycle and backup time.
ModifyBackupPolicy Modifies the backup policy of an ApsaraDB for Redis instance.
DescribeBackups Queries the backup files of an ApsaraDB for Redis instance.
RestoreInstance Restores the data in a backup file to a specified ApsaraDB for Redis instance.

Monitoring management

API Description
DescribeMonitorItems Queries the metrics of an ApsaraDB for Redis instance.
DescribeHistoryMonitorValues Queries the monitoring history of an ApsaraDB for Redis instance.

Log management

API Description
DescribeAuditRecords Queries audit logs of an ApsaraDB for Redis instance.
DescribeRunningLogRecords Queries operational logs of an ApsaraDB for Redis instance.
DescribeSlowLogRecords Queries slow logs of an ApsaraDB for Redis instance within a specified time period.
ModifyAuditLogConfig Modifies the audit log settings of an ApsaraDB for Redis instance.

Network security

API Description
DescribeSecurityIps Queries IP address whitelists of an ApsaraDB for Redis instance.
ModifySecurityIps Modifies IP address whitelists of an ApsaraDB for Redis instance.
DescribeSecurityGroupConfiguration Queries the security groups that are included in the whitelist of an ApsaraDB for Redis instance.
ModifySecurityGroupConfiguration Modifies the security groups in the whitelist of an ApsaraDB for Redis instance.
DescribeInstanceSSL Checks whether Secure Socket Layer (SSL) encryption is enabled for an ApsaraDB for Redis instance.
ModifyInstanceSSL Configures SSL encryption for an ApsaraDB for Redis instance.
ModifyInstanceVpcAuthMode Enables or disables password-free access for an ApsaraDB for Redis instance. When the password-free access feature is enabled, Elastic Compute Service (ECS) instances in the same VPC can access the ApsaraDB for Redis instance without the password. You can also use the username and password to access the ApsaraDB for Redis instance.

Parameter management

API Description
DescribeParameterTemplates Queries configuration parameters and their default values of an ApsaraDB for Redis instance in different architectures and major versions.
DescribeInstanceConfig Queries configuration parameters of an ApsaraDB for Redis instance.
DescribeParameters Queries configuration parameters and running parameters of an ApsaraDB for Redis instance.
ModifyInstanceConfig Modifies configuration parameters of an ApsaraDB for Redis instance.

Tag management

API Description
ListTagResources Queries the ApsaraDB for Redis instances that are bound to specified tags or queries the tags that are bound to specified ApsaraDB for Redis instances.
TagResources Binds tags to one or more ApsaraDB for Redis instances.
UntagResources Unbinds tags from ApsaraDB for Redis instances.

Cache analytics and frequently used key querying

API Description
Cache analytics You can call the API operations of Database Autonomy Service (DAS) to perform a cache analysis task or query frequently used keys.

Performance optimization

Note Alibaba Cloud has optimized the cache analysis feature for ApsaraDB for Redis and replaced the following API operations with new ones. For more information, see API operations for cache analysis will be upgraded.
API Description
CreateCacheAnalysisTask Creates a cache analysis task.
DescribeCacheAnalysisReportList Queries cache analysis reports of an ApsaraDB for Redis instance.
DescribeCacheAnalysisReport Queries the cache analysis report of an ApsaraDB for Redis instance on a specified date.