The following tables list the API operations available for use in ApsaraDB for Redis.
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 an ApsaraDB for Redis instance. |
| CreateInstances | Creates one or more ApsaraDB for Redis instances at a time. |
| CreateTairInstance | Creates a persistent memory-optimized or storage-optimized instance of the 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 configurations of an ApsaraDB for Redis instance. |
| ModifyNodeSpec | Changes the configurations of a 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 the details of one or more ApsaraDB for Redis instances. |
| DescribeInstancesOverview | Queries the overview information of one or more ApsaraDB for Redis instances. |
| DescribeInstanceAttribute | Queries the detailed information of an ApsaraDB for Redis instance. |
| DescribeGlobalDistributeCache | Queries the detailed information of a distributed ApsaraDB for Redis instance. |
| DescribeEngineVersion | Queries the major version and minor version of an ApsaraDB for Redis instance. |
| DescribeRoleZoneInfo | Queries 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 specific period. |
| DescribeDBInstanceNetInfo | Queries the network information of an ApsaraDB for Redis instance. |
| EnableAdditionalBandwidth | Adjusts the bandwidth of an ApsaraDB for Redis instance. |
| ModifyInstanceAttribute | Changes the attributes of an ApsaraDB for Redis instance, such as the name and the 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 | Changes 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 for 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 restored. |
| 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 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 | Changes 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 private endpoint for an ApsaraDB for Redis cluster instance. |
| ReleaseDirectConnection | Releases the private 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 an ApsaraDB for Redis instance. |
| RenewInstance | Renews an ApsaraDB for Redis instance. |
| DescribeInstanceAutoRenewalAttribute | Queries the auto-renewal state 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 the details of one or all of the accounts that are created in an ApsaraDB for Redis instance. |
| CreateAccount | Creates an account that has specific permissions for an ApsaraDB for Redis instance. |
| GrantAccountPrivilege | Changes the permissions of an account for an ApsaraDB for Redis instance. |
| ModifyAccountDescription | Changes 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 the 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 | Changes 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 specific 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 | Enables or disables the audit log feature and specifies a retention period for audit logs. |
| 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 logs of an ApsaraDB for Redis instance over a specific period of time. |
Network security
| Operation | Description |
|---|---|
| DescribeSecurityIps | Queries the IP address whitelists of an ApsaraDB for Redis instance. |
| ModifySecurityIps | Changes the IP addresses in a whitelist of an ApsaraDB for Redis instance. |
| DescribeSecurityGroupConfiguration | Queries the security groups that are configured for an ApsaraDB for Redis instance. |
| ModifySecurityGroupConfiguration | Changes the security groups that are configured for an ApsaraDB for Redis instance. |
| DescribeInstanceSSL | Checks whether 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 as the ApsaraDB for Redis instance can access the ApsaraDB for Redis instance without using passwords. You can still use a username and a 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 | Changes the configuration parameters of an ApsaraDB for Redis instance. |
Tag management
| Operation | Description |
|---|---|
| ListTagResources | Queries the ApsaraDB for Redis instances to which specific tags are added or queries the tags that are added to specific ApsaraDB for Redis instances. |
| TagResources | Adds specific tags to one or more ApsaraDB for Redis instances. |
| UntagResources | Removes specific tags from one or more ApsaraDB for Redis instances. |
Cache analytics and hotkey query
| Operation | Description |
|---|---|
| Real-time key statistics and offline key analysis | Allows you to call the API operations of Database Autonomy Service (DAS) to run cache analytics tasks or query hotkeys. |
Performance improvement
Note The cache analytics feature of ApsaraDB for Redis is optimized, and the API operations
described 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 an offline key analysis task. |
| DescribeCacheAnalysisReportList | Queries the offline key analytics reports for an ApsaraDB for Redis instance. |
| DescribeCacheAnalysisReport | Queries the offline key analysis reports that were generated on a specific date for an ApsaraDB for Redis instance. |
O&M task management
| Operation | Description |
|---|---|
| DescribeActiveOperationTask | Queries the details of O&M tasks of an ApsaraDB for Redis instance. |
| ModifyActiveOperationTask | Changes the scheduled switchover time for an O&M task of an ApsaraDB for Redis instance. |