List of operations by function

The following tables list the API operations available for use in ApsaraDB for Redis. For more information, see OpenAPI Explorer.

Lifecycle management

Operation	Description
DescribeRegions	Queries the regions in which ApsaraDB for Redis instances can be created.
DescribeZones	Queries the zones in which ApsaraDB for Redis instances can be created.
DescribeAvailableResource	Queries the types of ApsaraDB for Redis instances that can be created in a specific zone.
CreateInstance	Creates a single ApsaraDB for Redis instance.
CreateInstances	Creates multiple ApsaraDB for Redis instances at a time.
CreateTairInstance	Creates a persistent memory-optimized or storage-optimized instance of ApsaraDB for Redis Enhanced Edition (Tair) that uses cloud disks. For more information, see Persistent memory-optimized instances and Storage-optimized instances.
CreateGlobalDistributeCache	Converts an existing ApsaraDB for Redis instance to the first child instance of a distributed ApsaraDB for Redis instance.
ModifyInstanceSpec	Changes the specifications of an ApsaraDB for Redis instance.
ModifyNodeSpec	Changes the specifications of a data node in an ApsaraDB for Redis cluster instance.
AddShardingNode	Creates one or more data shards for an ApsaraDB for Redis cluster instance.
DeleteShardingNode	Deletes one or more data shards from an ApsaraDB for Redis cluster 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

Operation	Description
DescribeInstances	Queries information about one or more ApsaraDB for Redis instances.
DescribeInstanceAttribute	Queries information about a single ApsaraDB for Redis instance.
DescribeGlobalDistributeCache	Queries information about a distributed ApsaraDB for Redis instance.
DescribeEngineVersion	Queries information about the major version and minor version of an ApsaraDB for Redis instance.
DescribeRoleZoneInfo	Queries information about the role, type, minor version, and zone of each node in an ApsaraDB for Redis instance.
DescribeClusterMemberInfo	Queries the configuration information of nodes in an ApsaraDB for Redis cluster instance, such as specifications and the maximum number of connections.
DescribeTasks	Queries all tasks that are performed by an ApsaraDB for Redis instance within a specified period.
DescribeDBInstanceNetInfo	Queries the network information of an ApsaraDB for Redis instance.
EnableAdditionalBandwidth	Adjusts the bandwidth of an ApsaraDB for Redis instance.
ModifyInstanceAttribute	Modifies the attributes of an ApsaraDB for Redis instance, such as the name and password.
ModifyResourceGroup	Changes 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	Updates the minor version of an ApsaraDB for Redis instance.
RestartInstance	Restarts an ApsaraDB for Redis instance that is running.
FlushExpireKeys	Deletes the expired keys of an ApsaraDB for Redis instance.
SwitchInstanceHA	Performs a master-replica switchover in an ApsaraDB for Redis instance to switch node roles. You can use this operation for disaster recovery drills. If the ApsaraDB for Redis instance is deployed across multiple zones, you can also use this operation to connect an application to the zone that is closest to the application.
FlushInstance	Deletes the data of an ApsaraDB for Redis instance. Deleted data cannot be recovered.
MigrateToOtherZone	Migrates an ApsaraDB for Redis instance to another zone in the same region.
RemoveSubInstance	Removes a child instance from a distributed instance and converts the child instance into a regular ApsaraDB for Redis instance with data retained.

Connection management

Operation	Description
SwitchNetwork	Changes the network type of an ApsaraDB for Redis instance from classic network to virtual private cloud (VPC).
ModifyInstanceNetExpireTime	Extends the retention period of the classic network endpoint of an ApsaraDB for Redis instance. You can call this operation after you change the network type of the ApsaraDB for Redis instance from classic network to VPC with the classic network endpoint retained.
ModifyDBInstanceConnectionString	Modifies an endpoint of an ApsaraDB for Redis instance.
AllocateInstancePublicConnection	Applies for a public endpoint for an ApsaraDB for Redis instance.
ReleaseInstancePublicConnection	Releases the public endpoint of an ApsaraDB for Redis instance.
AllocateDirectConnection	Applies for a direct connection endpoint for an ApsaraDB for Redis cluster instance.
ReleaseDirectConnection	Releases the direct connection endpoint of an ApsaraDB for Redis cluster instance.
DescribeIntranetAttribute	Queries the current maximum internal bandwidth of an ApsaraDB for Redis instance. If you adjust the internal bandwidth and the new internal bandwidth is valid only for a short period of time, this operation also returns the expiration time of the new internal bandwidth.

Renewal management

Operation	Description
DescribePrice	Queries the fees that you must pay when you create, upgrade, or renew ApsaraDB for Redis instances.
RenewInstance	Renews an ApsaraDB for Redis instance.
DescribeInstanceAutoRenewalAttribute	Queries the auto-renewal status of an ApsaraDB for Redis instance.
ModifyInstanceAutoRenewalAttribute	Enables or disables auto-renewal for an ApsaraDB for Redis instance.
RenewAdditionalBandwidth	Renews the extra bandwidth that you purchased for an ApsaraDB for Redis instance.

Account management

Operation	Description
DescribeAccounts	Queries information about one or all of the accounts that are created in an ApsaraDB for Redis instance.
CreateAccount	Creates an account that has specified permissions for an ApsaraDB for Redis instance.
GrantAccountPrivilege	Modifies the permissions of an account for an ApsaraDB for Redis instance.
ModifyAccountDescription	Modifies the description of an account for an ApsaraDB for Redis instance.
ModifyAccountPassword	Changes the password of an account for an ApsaraDB for Redis instance.
ResetAccountPassword	Resets the password of an account for an ApsaraDB for Redis instance.
DeleteAccount	Deletes an account of an ApsaraDB for Redis instance.

Backup and restoration

Operation	Description
CreateBackup	Backs up an ApsaraDB for Redis instance.
DescribeBackupTasks	Queries information about backup tasks of an ApsaraDB for Redis instance.
DescribeBackupPolicy	Queries the backup policy of an ApsaraDB for Redis instance. The backup policy includes information such as the backup cycle and the 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

Operation	Description
DescribeMonitorItems	Queries the metrics of an ApsaraDB for Redis instance.
DescribeHistoryMonitorValues	Queries the historical monitoring data of an ApsaraDB for Redis instance.

Log management

Operation	Description
ModifyAuditLogConfig	Modifies the audit log settings of an ApsaraDB for Redis instance.
DescribeAuditLogConfig	Queries the audit log configurations of an ApsaraDB for Redis instance. The configurations include whether to enable the audit log feature and the retention period of audit logs.
DescribeAuditRecords	Queries the audit logs of an ApsaraDB for Redis instance.
DescribeRunningLogRecords	Queries the operational logs of an ApsaraDB for Redis instance.
DescribeSlowLogRecords	Queries the slow query logs of an ApsaraDB for Redis instance over a specified period of time.

Network security

Operation	Description
DescribeSecurityIps	Queries the IP address whitelists of an ApsaraDB for Redis instance.
ModifySecurityIps	Modifies an IP address whitelist of an ApsaraDB for Redis instance.
DescribeSecurityGroupConfiguration	Queries the security groups that are configured for an ApsaraDB for Redis instance.
ModifySecurityGroupConfiguration	Modifies the security groups that are configured for 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. If password-free access is enabled for an ApsaraDB for Redis instance, Elastic Compute Service (ECS) instances that reside in the same VPC can access the ApsaraDB for Redis instance without the need to use passwords. You can still use the username and password to access the ApsaraDB for Redis instance.

TDE

Operation	Description
ModifyInstanceTDE	Enables transparent data encryption (TDE) for an ApsaraDB for Redis instance. You can use automatically generated keys or existing custom keys.
DescribeInstanceTDEStatus	Queries whether TDE is enabled for an ApsaraDB for Redis instance.
DescribeEncryptionKeyList	Queries the custom keys that are available for an ApsaraDB for Redis instance to use TDE.
DescribeEncryptionKey	Queries the details of a custom key for an ApsaraDB for Redis instance to use TDE.
CheckCloudResourceAuthorized	Queries whether an ApsaraDB for Redis instance is authorized to use Key Management Service (KMS).

Parameter management

Operation	Description
DescribeParameterTemplates	Queries the parameters and default values that are supported by an ApsaraDB for Redis instance in different architectures and major versions.
DescribeInstanceConfig	Queries the configuration parameters of an ApsaraDB for Redis instance.
DescribeParameters	Queries the configuration parameters and operational parameters of an ApsaraDB for Redis instance.
ModifyInstanceConfig	Modifies the configuration parameters of an ApsaraDB for Redis instance.

Tag management

Operation	Description
ListTagResources	Queries the ApsaraDB for Redis instances to which specified tags are added or queries the tags that are added to specified ApsaraDB for Redis instances.
TagResources	Adds specified tags to one or more ApsaraDB for Redis instances.
UntagResources	Removes specified tags from one or more ApsaraDB for Redis instances.

Cache analysis and hotkey query

Operation	Description
Cache analysis and key analysis	Allows you to call the API operations of Database Autonomy Service (DAS) to run a cache analysis task or query hotkeys.

Performance optimization

Note The cache analysis feature of ApsaraDB for Redis is optimized, and the API operations in the following table are replaced with new API operations. For more information, see API operations for cache analysis will be upgraded.

Operation	Description
CreateCacheAnalysisTask	Creates a cache analysis task.
DescribeCacheAnalysisReportList	Queries the cache analysis reports of an ApsaraDB for Redis instance.
DescribeCacheAnalysisReport	Queries the cache analysis reports that are generated on a specified date for an ApsaraDB for Redis instance.

O&M task management

Operation	Description
DescribeActiveOperationTask	Queries information about the O&M tasks of an ApsaraDB for Redis instance.
ModifyActiveOperationTask	Modifies the scheduled switchover time for an O&M task of an ApsaraDB for Redis instance.