This product(
R-kvstore/2015-01-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Lifecycle management
| API | Title | Description |
|---|---|---|
| CreateInstance | CreateInstance | Creates an ApsaraDB for Redis instance. |
| AddShardingNode | AddShardingNode | Adds one or more data shards to an ApsaraDB for Redis cluster instance. |
| CreateGlobalDistributeCache | CreateGlobalDistributeCache | Converts an existing ApsaraDB for Redis instance to the first child instance of a distributed ApsaraDB for Redis instance. |
| DeleteShardingNode | DeleteShardingNode | Removes one or more data shards from an ApsaraDB for Redis cluster instance. |
| DeleteInstance | DeleteInstance | The ID of the request. |
| ModifyInstanceSpec | ModifyInstanceSpec | Changes the specifications of an ApsaraDB for Redis instance. |
| DescribeRegions | DescribeRegions | Queries the regions in which ApsaraDB for Redis instances can be created. |
| DescribeZones | DescribeZones | Queries the zones available for ApsaraDB for Redis. |
| DescribeAvailableResource | DescribeAvailableResource | Queries the types of ApsaraDB for Redis instances that can be created in a specified zone. |
| TransformToPrePaid | TransformToPrePaid | Changes the billing method of an ApsaraDB for Redis instance from pay-as-you-go to subscription. |
| MigrateToOtherZone | MigrateToOtherZone | Migrates an ApsaraDB for Redis instance to another zone in the same region. |
Instance management
| API | Title | Description |
|---|---|---|
| CreateTairInstance | CreateTairInstance | Creates an ApsaraDB for Redis Enhanced Edition (Tair) instance that uses cloud disks. |
| CreateInstances | CreateInstances | Creates multiple ApsaraDB for Redis instances at a time. |
| EnableAdditionalBandwidth | EnableAdditionalBandwidth | Adjusts the bandwidth of an ApsaraDB for Redis instance. |
| ModifyInstanceAttribute | ModifyInstanceAttribute | Changes the information of an ApsaraDB for Redis instance, such as the name and password. |
| ModifyResourceGroup | ModifyResourceGroup | Changes the resource group to which an ApsaraDB for Redis instance belongs. |
| ModifyInstanceMaintainTime | ModifyInstanceMaintainTime | Modifies the maintenance window of an ApsaraDB for Redis instance. Alibaba Cloud maintains ApsaraDB for Redis instances during the specified maintenance window. |
| ModifyInstanceMajorVersion | ModifyInstanceMajorVersion | Upgrades the major version of an ApsaraDB for Redis instance. |
| ModifyInstanceMinorVersion | ModifyInstanceMinorVersion | Updates the minor version of an ApsaraDB for Redis instance. |
| DescribeInstancesOverview | DescribeInstancesOverview | Queries the overview information of one or more ApsaraDB for Redis instances. |
| DescribeInstances | DescribeInstances | Queries the information about one or more ApsaraDB for Redis instances. |
| DescribeInstanceAttribute | DescribeInstanceAttribute | Queries the details of an ApsaraDB for Redis instance. |
| DescribeGlobalDistributeCache | DescribeGlobalDistributeCache | Queries the details of a distributed ApsaraDB for Redis instance. |
| DescribeEngineVersion | DescribeEngineVersion | Queries the major version and minor version of an ApsaraDB for Redis instance and the release notes for minor versions. |
| DescribeRoleZoneInfo | DescribeRoleZoneInfo | The default bandwidth of the node. Unit: MB/s. |
| DescribeClusterMemberInfo | DescribeClusterMemberInfo | Queries the configuration information of nodes in an ApsaraDB for Redis cluster instance, such as specifications and the maximum number of connections. |
| DescribeTasks | DescribeTasks | Queries all tasks that are performed on an ApsaraDB for Redis instance within a specified period of time. |
| DescribeDBInstanceNetInfo | DescribeDBInstanceNetInfo | Queries the network information of an ApsaraDB for Redis instance. |
| DescribeLogicInstanceTopology | DescribeLogicInstanceTopology | Queries the logical topology of an ApsaraDB for Redis instance. |
| RestartInstance | RestartInstance | Restarts a running ApsaraDB for Redis instance. |
| FlushExpireKeys | FlushExpireKeys | Deletes the expired keys from an ApsaraDB for Redis instance. |
| FlushInstance | FlushInstance | Clears the data of an ApsaraDB for Redis instance. The cleared data cannot be restored. |
| SwitchInstanceHA | SwitchInstanceHA | Performs a master-replica switchover to switch node roles. This operation is applicable to disaster recovery drills and nearby access to applications that are deployed across zones. |
| SyncDtsStatus | SyncDtsStatus | Disables configuration changes for an ApsaraDB for Redis instance before you use Data Transmission Service (DTS) to migrate or synchronize data of the instance. This prevents migration and synchronization task failures due to the configuration change. |
| RemoveSubInstance | RemoveSubInstance | Removes a child instance from a distributed instance. |
Connection management
| API | Title | Description |
|---|---|---|
| ModifyInstanceNetExpireTime | 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 Virtual Private Cloud (VPC) with the classic network endpoint retained. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Changes the endpoint or port number of an ApsaraDB for Redis instance. |
| ModifyIntranetAttribute | ModifyIntranetAttribute | Temporarily adjusts the internal bandwidth of an ApsaraDB for Redis instance that is deployed in a dedicated cluster. |
| DescribeIntranetAttribute | DescribeIntranetAttribute | Queries the internal bandwidth of an ApsaraDB for Redis instance. If you have purchased extra internal bandwidth, the expiration time of the purchased bandwidth is also returned. |
| SwitchNetwork | SwitchNetwork | Changes the virtual private cloud (VPC) or vSwitch of an ApsaraDB for Redis instance. If the instance is deployed in the classic network, the network type of the instance is changed from the classic network to VPC. |
| AllocateInstancePublicConnection | AllocateInstancePublicConnection | Applies for a public endpoint for an ApsaraDB for Redis instance. |
| ReleaseInstancePublicConnection | ReleaseInstancePublicConnection | Releases the public endpoint of an ApsaraDB for Redis instance. |
| AllocateDirectConnection | AllocateDirectConnection | Applies for a private endpoint for an ApsaraDB for Redis cluster instance. |
| ReleaseDirectConnection | ReleaseDirectConnection | Releases the private endpoint of an ApsaraDB for Redis cluster instance. |
| SwitchInstanceProxy | SwitchInstanceProxy | Enables or disables the proxy mode for an ApsaraDB for Redis cluster instance in a dedicated cluster. |
Renewal management
| API | Title | Description |
|---|---|---|
| ModifyInstanceAutoRenewalAttribute | ModifyInstanceAutoRenewalAttribute | Enables or disables auto-renewal for an ApsaraDB for Redis instance. |
| DescribePrice | DescribePrice | Queries the fees that you must pay when you create, upgrade, or renew an ApsaraDB for Redis instance. |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute | Queries whether auto-renewal is enabled for an ApsaraDB for Redis instance. |
| RenewAdditionalBandwidth | RenewAdditionalBandwidth | Renews the purchased bandwidth for an ApsaraDB for Redis instance. |
| TransformInstanceChargeType | TransformInstanceChargeType | Changes the billing method of an ApsaraDB for Redis instance from subscription to pay-as-you-go or from pay-as-you-go to subscription. |
| RenewInstance | RenewInstance | Renews an ApsaraDB for Redis instance. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates an account that has specific permissions for an ApsaraDB for Redis instance. |
| DeleteAccount | DeleteAccount | Deletes an account from an ApsaraDB for Redis instance. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of an account for an ApsaraDB for Redis instance. |
| ModifyAccountPassword | ModifyAccountPassword | Changes the password of a specific account for an ApsaraDB for Redis instance. |
| DescribeAccounts | DescribeAccounts | Queries all accounts or a specified account of an ApsaraDB for Redis instance. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of an account for an ApsaraDB for Redis instance. |
| GrantAccountPrivilege | GrantAccountPrivilege | Modifies the permissions of an account for an ApsaraDB for Redis instance. |
Backup and restoration
| API | Title | Description |
|---|---|---|
| CreateBackup | CreateBackup | Backs up an ApsaraDB for Redis instance. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy of an ApsaraDB for Redis instance. |
| DescribeBackupTasks | DescribeBackupTasks | Queries the states of backup tasks for an ApsaraDB for Redis instance. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup policy of an ApsaraDB for Redis instance, including the backup cycle and backup time. |
| DescribeBackups | DescribeBackups | The ID of the backup task. |
| RestoreInstance | RestoreInstance | Restores the data in a backup file to a specified ApsaraDB for Redis instance. |
Monitoring management
| API | Title | Description |
|---|---|---|
| DescribeMonitorItems | DescribeMonitorItems | Queries the metrics of an ApsaraDB for Redis instance. |
| DescribeHistoryMonitorValues | DescribeHistoryMonitorValues | Queries the performance monitoring data of an ApsaraDB for Redis instance. |
Log management
| API | Title | Description |
|---|---|---|
| ModifyAuditLogConfig | ModifyAuditLogConfig | Modifies the audit log settings of an ApsaraDB for Redis instance. |
| DescribeAuditLogConfig | DescribeAuditLogConfig | Queries the audit log configurations of an ApsaraDB for Redis instance. The configurations include whether the audit log feature is enabled and the retention period of audit logs. |
| DescribeAuditRecords | DescribeAuditRecords | Queries the audit logs of an ApsaraDB for Redis instance. |
| DescribeRunningLogRecords | DescribeRunningLogRecords | Queries the active logs of an ApsaraDB for Redis instance. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the slow logs of an ApsaraDB for Redis instance that are generated within a specified period of time. |
| InitializeKvstorePermission | InitializeKvstorePermission | Assigns a service-linked role to ApsaraDB for Redis. |
Network security
| API | Title | Description |
|---|---|---|
| ModifySecurityIps | ModifySecurityIps | Modifies the IP address whitelists of an ApsaraDB for Redis instance. |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration | Resets the security groups that are added to the whitelists of an ApsaraDB for Redis instance. |
| ModifyInstanceSSL | ModifyInstanceSSL | Modifies the SSL settings of an ApsaraDB for Redis instance. |
| ModifyInstanceVpcAuthMode | ModifyInstanceVpcAuthMode | Enables or disables password-free access for an ApsaraDB for Redis instance. This way, you can connect to a database in a convenient and secure manner. |
| DescribeSecurityIps | DescribeSecurityIps | Queries the IP address whitelists of an ApsaraDB for Redis instance. |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration | Queries the security groups that are added to the whitelists of an ApsaraDB for Redis instance. |
| DescribeInstanceSSL | DescribeInstanceSSL | Queries whether TLS (SSL) encryption is enabled for an instance. |
Parameter management
| API | Title | Description |
|---|---|---|
| ModifyInstanceConfig | ModifyInstanceConfig | Modifies the parameter settings of an ApsaraDB for Redis instance. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries the parameters and their default values that are supported by ApsaraDB for Redis instances of different architectures and major versions. |
| DescribeInstanceConfig | DescribeInstanceConfig | Queries the parameter settings of an ApsaraDB for Redis instance. |
| DescribeParameters | DescribeParameters | Queries the configuration parameters and running parameters of an ApsaraDB for Redis instance. |
| DescribeParameterModificationHistory | DescribeParameterModificationHistory | Queries the parameter modification history of a Tair or ApsaraDB for Redis instance. |
Tag management
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Queries the relationships between ApsaraDB for Redis instances and tags. |
| TagResources | TagResources | Adds specified tags to one or more ApsaraDB for Redis instances. |
| UntagResources | UntagResources | Removes tags from one or more ApsaraDB for Redis instances. |
Performance improvements
| API | Title | Description |
|---|---|---|
| CreateCacheAnalysisTask | CreateCacheAnalysisTask | Manually creates a cache analysis task. |
| DescribeCacheAnalysisReport | DescribeCacheAnalysisReport | Queries the cache analytics report that is generated on a specified date for an ApsaraDB for Redis instance. |
| DescribeCacheAnalysisReportList | DescribeCacheAnalysisReportList | Queries the cache analytics reports of an ApsaraDB for Redis instance. |
TDE
| API | Title | Description |
|---|---|---|
| ModifyInstanceTDE | ModifyInstanceTDE | Enables transparent data encryption (TDE) for an ApsaraDB for Redis instance. You can use existing custom keys. |
| DescribeInstanceTDEStatus | DescribeInstanceTDEStatus | Queries whether transparent data encryption (TDE) is enabled for an ApsaraDB for Redis instance. |
| DescribeEncryptionKeyList | DescribeEncryptionKeyList | Queries the custom keys used by an ApsaraDB for Redis instance. |
| DescribeEncryptionKey | DescribeEncryptionKey | Queries the details of a Transparent Data Encryption (TDE) custom key for an ApsaraDB for Redis instance. |
| CheckCloudResourceAuthorized | CheckCloudResourceAuthorized | Queries whether an ApsaraDB for Redis instance is authorized to use Key Management Service (KMS). |
O\&M task management
| API | Title | Description |
|---|---|---|
| ModifyActiveOperationTask | ModifyActiveOperationTask | Changes the scheduled switchover time of an O\\\&M task. |
| DescribeActiveOperationTask | DescribeActiveOperationTask | The list of O\\\&M tasks. |
Other
| API | Title | Description |
|---|---|---|
| DescribeDedicatedClusterInstanceList | DescribeDedicatedClusterInstanceList | Queries the information of an ApsaraDB for Redis instance deployed in a dedicated cluster. |
| DescribeHistoryTasks | DescribeHistoryTasks | Queries tasks. |
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Queries global IP whitelist templates. |
| FlushInstanceForDB | FlushInstanceForDB | Cleans the data of specified databases in an instance. |