API standard and pre-built SDKs in multi-language
This product (R-kvstore/2015-01-01) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Lifecycle management
| API | Title | Description |
|---|---|---|
| CreateInstance | CreateInstance | Creates a Tair (Redis OSS-compatible) instance. If you want to create a Tair (Enterprise Edition) cloud-native instance, you can call the CreateTairInstance operation. |
| AddShardingNode | AddShardingNode | Adds one or more data shards to a Tair cluster instance. |
| CreateGlobalDistributeCache | CreateGlobalDistributeCache | Converts an existing Tair DRAM-based classic instance to the first child instance of a distributed instance. |
| DeleteShardingNode | DeleteShardingNode | Removes one or more data shards from a Tair (Redis OSS-compatible) cluster instance. |
| DeleteInstance | DeleteInstance | Releases a Tair (Redis OSS-compatible) instance. |
| DestroyInstance | DestroyInstance | Permanently destroys instances and their data backups in the recycle bin. |
| ModifyInstanceSpec | ModifyInstanceSpec | Changes the configurations of a Tair (Redis OSS-compatible) instance. |
| DescribeRegions | DescribeRegions | Queries all regions and zones supported for a Tair (Redis OSS-compatible) instance. |
| DescribeZones | DescribeZones | Queries the zones that support Tair (Redis OSS-compatible) in a specific region. To query the zones where Tair (Redis OSS-compatible) instances can be purchased, call the DescribeAvailableResource operation. |
| DescribeAvailableResource | DescribeAvailableResource | Queries the types of Tair (Redis OSS-compatible) instances that can be created in a specified zone. |
| TransformToPrePaid | TransformToPrePaid | Changes a pay-as-you-go Tair (Redis OSS-compatible) instance to a subscription instance. |
| MigrateToOtherZone | MigrateToOtherZone | Migrates a Tair (Redis OSS-compatible) instance to another zone in the same region. |
Instance management
| API | Title | Description |
|---|---|---|
| CreateTairInstance | CreateTairInstance | Creates a Tair (Enterprise Edition) cloud-native instance. |
| CreateInstances | CreateInstances | Creates multiple Tair (Redis OSS-compatible) instances at a time. |
| EnableAdditionalBandwidth | EnableAdditionalBandwidth | Adjusts the bandwidth of a Tair (Redis OSS-compatible) instance. Only the pay-as-you-go billing method is supported for bandwidth adjustment. You need to specify the InstanceId, NodeId (optional), Bandwidth, and ChargeType parameters. |
| ModifyInstanceAttribute | ModifyInstanceAttribute | Modifies the specific information of a Tair (Redis OSS-compatible) instance, such as the password and the name. |
| ModifyResourceGroup | ModifyResourceGroup | Modifies the resource group to which a Tair (Redis OSS-compatible) instance belongs. |
| ModifyInstanceMaintainTime | ModifyInstanceMaintainTime | Modifies the maintenance window of a Tair (Redis OSS-compatible) instance. Alibaba Cloud maintains Tair (Redis OSS-compatible) instances during the specified maintenance window. |
| ModifyInstanceMajorVersion | ModifyInstanceMajorVersion | Upgrades the major version of a Tair (Redis OSS-compatible) instance. |
| ModifyInstanceMinorVersion | ModifyInstanceMinorVersion | Updates the minor version of a Tair (Redis OSS-compatible) instance. |
| ModifyDBInstanceAutoUpgrade | ModifyDBInstanceAutoUpgrade | Modifies the settings related to the automatic minor version update for an instance. |
| DescribeInstancesOverview | DescribeInstancesOverview | Queries the overview information of one or more Tair (Redis OSS-compatible) instances. |
| DescribeInstances | DescribeInstances | Queries the information about one or more Tair (Redis OSS-compatible) instances. |
| DescribeDedicatedClusterInstanceList | DescribeDedicatedClusterInstanceList | Queries the information of Tair (Redis OSS-compatible) instances deployed in a dedicated cluster. |
| DescribeInstanceAttribute | DescribeInstanceAttribute | Queries the attribute of Tair (Redis OSS-compatible) instances. |
| DescribeGlobalDistributeCache | DescribeGlobalDistributeCache | Queries the details of a distributed Tair (Redis OSS-compatible) instance. |
| DescribeEngineVersion | DescribeEngineVersion | Queries the major version and minor version of a Tair (Redis OSS-compatible) instance and the release notes for minor versions. |
| DescribeRoleZoneInfo | DescribeRoleZoneInfo | Queries the role, type, minor version, and zone of each node in a Tair (Redis OSS-compatible) instance. |
| DescribeClusterMemberInfo | DescribeClusterMemberInfo | Queries the configuration information of nodes in a Tair (Redis OSS-compatible) cluster instance, such as the specifications and the maximum number of connections. |
| DescribeDBInstanceNetInfo | DescribeDBInstanceNetInfo | Queries the network information of a Tair (Redis OSS-compatible) instance. |
| DescribeDBNodeDirectVipInfo | DescribeDBNodeDirectVipInfo | Queries the information about virtual IP addresses (VIPs) of child instances of a cluster instance in direct connection mode. |
| DescribeLogicInstanceTopology | DescribeLogicInstanceTopology | Queries the logical topology of a Tair (Redis OSS-compatible) instance. |
| RestartInstance | RestartInstance | Restarts a running Tair (Redis OSS-compatible) instance. |
| FlushExpireKeys | FlushExpireKeys | Clears all expired keys in a Tair (Redis OSS-compatible) instance. |
| FlushInstanceForDB | FlushInstanceForDB | Cleans the data of specified databases in a Tair (Redis OSS-compatible) instance. |
| FlushInstance | FlushInstance | Clears the data of a Tair (Redis OSS-compatible) 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 a Tair (Redis OSS-compatible) 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 configuration changes. |
| RemoveSubInstance | RemoveSubInstance | Removes a child instance from a distributed instance. |
| LockDBInstanceWrite | LockDBInstanceWrite | Locks an instance. After the instance is locked, you can only read data from the instance, but cannot write data to the instance. |
| UnlockDBInstanceWrite | UnlockDBInstanceWrite | Unlocks a write-locked instance. After the instance is unlocked, you can read and write data to and from the instance. |
| RebootProxy | RebootProxy | Restarts the proxy node of a running Tair (Redis OSS-compatible) instance. |
| UpgradeProxy | UpgradeProxy | Updates the proxy node of a cluster instance to the latest version. |
Connection management
| API | Title | Description |
|---|---|---|
| ModifyInstanceNetExpireTime | ModifyInstanceNetExpireTime | Extends the retention period of the classic network endpoint of a Tair (Redis OSS-compatible) instance. You can call this operation after you change the network type of the Tair (Redis OSS-compatible) instance from classic network to Virtual Private Cloud (VPC) with the classic network endpoint retained. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Changes the endpoint or port number of a Tair (Redis OSS-compatible) instance. |
| ModifyIntranetAttribute | ModifyIntranetAttribute | Temporarily adjusts the internal bandwidth of a Tair (Redis OSS-compatible) instance that is deployed in a dedicated cluster. |
| DescribeIntranetAttribute | DescribeIntranetAttribute | Queries the current bandwidth of a Tair (Redis OSS-compatible) instance. |
| SwitchNetwork | SwitchNetwork | Changes the VPC or vSwitch of a Tair (Redis OSS-compatible) 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 a Tair (Redis OSS-compatible) instance. |
| ReleaseInstancePublicConnection | ReleaseInstancePublicConnection | Releases the public endpoint of a Tair (Redis OSS-compatible) instance. |
| AllocateDirectConnection | AllocateDirectConnection | Applies for a private endpoint for a Tair (Redis OSS-compatible) instance. |
| ReleaseDirectConnection | ReleaseDirectConnection | Releases the private endpoint of a Tair (Redis OSS-compatible) cluster instance. |
| SwitchInstanceProxy | SwitchInstanceProxy | Enables or disables the proxy mode for a Tair (Redis OSS-compatible) cluster instance in a dedicated cluster. |
Renewal management
| API | Title | Description |
|---|---|---|
| ModifyInstanceAutoRenewalAttribute | ModifyInstanceAutoRenewalAttribute | Enables or disables auto-renewal for a Tair (Redis OSS-compatible) instance. |
| DescribePrice | DescribePrice | Queries the fees that you must pay when you create, upgrade, or renew a Tair (Redis OSS-compatible) instance. |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute | Queries whether auto-renewal is enabled for a Tair (Redis OSS-compatible) instance. |
| RenewAdditionalBandwidth | RenewAdditionalBandwidth | This operation is not recommended now. The billing method for bandwidth of a Tair (Redis OSS-compatible) instance is changed to pay-as-you-go. |
| TransformInstanceChargeType | TransformInstanceChargeType | Changes the billing method of a Tair (Redis OSS-compatible) instance from subscription to pay-as-you-go or from pay-as-you-go to subscription. |
| RenewInstance | RenewInstance | Renews a Tair (Redis OSS-compatible) subscription instance. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates an account that has specific permissions for a Tair (Redis OSS-compatible) instance. |
| DeleteAccount | DeleteAccount | Deletes an account from a Tair (Redis OSS-compatible) instance. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of an account for a Tair (Redis OSS-compatible) instance. |
| ModifyAccountPassword | ModifyAccountPassword | Modifies the password of an account for a Tair (Redis OSS-compatible) instance. |
| DescribeAccounts | DescribeAccounts | Queries a specified account of a Tair (Redis OSS-compatible) instance. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of an account for a Tair (Redis OSS-compatible) instance. |
| GrantAccountPrivilege | GrantAccountPrivilege | Modifies the permissions of an account for a Tair (Redis OSS-compatible) instance. |
Backup and restoration
| API | Title | Description |
|---|---|---|
| CreateBackup | CreateBackup | Backs up a Tair (Redis OSS-compatible) instance. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy of a Tair (Redis OSS-compatible) instance. |
| DescribeBackupTasks | DescribeBackupTasks | Queries the execution status of backup tasks for a Tair (Redis OSS-compatible) instance. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup policy of a Tair (Redis OSS-compatible) instance, including the backup cycle and backup time. |
| DescribeBackups | DescribeBackups | Queries the backup files of the Tair (Redis OSS-compatible) instance. |
| RestoreInstance | RestoreInstance | Restores the data in a backup file to a specified Tair (Redis OSS-compatible) instance. |
| DescribeClusterBackupList | DescribeClusterBackupList | Queries the backup sets of a Tair (Redis OSS-compatible) cluster instance. |
Monitoring management
| API | Title | Description |
|---|---|---|
| DescribeDBInstanceMonitor | DescribeDBInstanceMonitor | Queries the collection frequency of monitoring data for a Tair (Redis OSS-compatible) instance. |
| DescribeMonitorItems | DescribeMonitorItems | Queries the metrics of a Tair (Redis OSS-compatible) instance. |
| DescribeHistoryMonitorValues | DescribeHistoryMonitorValues | Queries the performance monitoring data of a Tair (Redis OSS-compatible) instance. |
Log management
| API | Title | Description |
|---|---|---|
| ModifyAuditLogConfig | ModifyAuditLogConfig | Enables the audit log feature or modifies the audit log settings for a Tair (Redis OSS-compatible) instance. |
| DescribeAuditLogConfig | DescribeAuditLogConfig | Queries the audit log configurations of a Tair (Redis OSS-compatible) 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 a Tair (Redis OSS-compatible) instance. |
| DescribeRunningLogRecords | DescribeRunningLogRecords | Queries the operational logs of a Tair (Redis OSS-compatible) instance. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the slow query logs of a Tair (Redis OSS-compatible) instance that are generated within a specified period of time. |
| InitializeKvstorePermission | InitializeKvstorePermission | Assigns a service-linked role to Tair (Redis OSS-compatible). |
| DescribeServiceLinkedRoleExists | DescribeServiceLinkedRoleExists | Queries whether the related service-linked role is created for Tair (Redis OSS-compatible) in the current account. |
Network security
| API | Title | Description |
|---|---|---|
| ModifySecurityIps | ModifySecurityIps | Configures an IP address whitelist for a Tair (Redis OSS-compatible) instance. |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration | Resets the security groups that are added to the whitelists of a Tair (Redis OSS-compatible) instance. |
| ModifyInstanceSSL | ModifyInstanceSSL | Enables Transport Layer Security (TLS) for a Tair (Redis OSS-compatible) instance. |
| ModifyInstanceVpcAuthMode | ModifyInstanceVpcAuthMode | Enables or disables password-free access for a Tair (Redis OSS-compatible) instance. This way, you can connect to a database in a convenient and secure manner. |
| DescribeSecurityIps | DescribeSecurityIps | Queries the IP address whitelists of a Tair (Redis OSS-compatible) instance. |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration | Queries the security groups that are added to the whitelists of a Tair (Redis OSS-compatible) instance. |
| DescribeInstanceSSL | DescribeInstanceSSL | Queries whether TLS (SSL) encryption is enabled for a Tair (Redis OSS-compatible) instance. |
Parameter management
| API | Title | Description |
|---|---|---|
| ModifyInstanceConfig | ModifyInstanceConfig | Modifies the parameter settings of a Tair (Redis OSS-compatible) instance. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries the parameters and their default values that are supported by Tair (Redis OSS-compatible) instances of different architectures and major versions. |
| DescribeInstanceConfig | DescribeInstanceConfig | Queries the default parameter configurations of a Tair (Redis OSS-compatible) instance. |
| DescribeParameters | DescribeParameters | Queries the configuration parameters and running parameters of a Tair (Redis OSS-compatible) instance. |
| DescribeParameterModificationHistory | DescribeParameterModificationHistory | Queries the parameter modification history of a Tair (Redis OSS-compatible) instance. |
Tag management
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Queries the relationships between Tair (Redis OSS-compatible) instances and tags. |
| TagResources | TagResources | Adds tags to Tair (Redis OSS-compatible) instances. |
| UntagResources | UntagResources | Removes tags from Tair (Redis OSS-compatible) instances. |
Performance improvements
| API | Title | Description |
|---|---|---|
| CreateCacheAnalysisTask | CreateCacheAnalysisTask | Creates a cache analysis task. |
| DescribeCacheAnalysisReport | DescribeCacheAnalysisReport | Queries the cache analysis report of an instance on a specified date. |
| DescribeCacheAnalysisReportList | DescribeCacheAnalysisReportList | Queries a list of cache analysis reports for an instance. |
TDE
| API | Title | Description |
|---|---|---|
| ModifyInstanceTDE | ModifyInstanceTDE | Enables transparent data encryption (TDE) for a Tair (Redis OSS-compatible) instance. You can use existing custom keys. |
| DescribeInstanceTDEStatus | DescribeInstanceTDEStatus | Queries whether transparent data encryption (TDE) is enabled for a Tair (Redis OSS-compatible) instance. |
| DescribeEncryptionKeyList | DescribeEncryptionKeyList | Queries a list of custom keys used by Tair (Redis OSS-compatible) instances. |
| DescribeEncryptionKey | DescribeEncryptionKey | Queries the details of a custom key for a Tair (Redis OSS-compatible) instance to use transparent data encryption (TDE). |
| CheckCloudResourceAuthorized | CheckCloudResourceAuthorized | Queries whether a Tair (Redis OSS-compatible) instance has the permissions to use Key Management Service (KMS). |
O\\\&M task management
| API | Title | Description |
|---|---|---|
| DescribeActiveOperationTaskCount | DescribeActiveOperationTaskCount | Queries the number of O\\\&M tasks on a Tair (Redis OSS-compatible) instance. |
| DescribeHistoryTasks | DescribeHistoryTasks | Queries a list of tasks in the task center. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries the task statistics in the task center. |
| ModifyActiveOperationTask | ModifyActiveOperationTask | Changes the scheduled switchover time of an O\&M task. |
| DescribeActiveOperationTask | DescribeActiveOperationTask | Queries the details of the O\\\&M tasks of a Tair (Redis OSS-compatible) instance. |
| DescribeActiveOperationMaintenanceConfig | DescribeActiveOperationMaintenanceConfig | Queries the O\\\&M task configurations of an instance. |
| ModifyActiveOperationMaintainConfig | ModifyActiveOperationMaintainConfig |
Whitelist template management
| API | Title | Description |
|---|---|---|
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | Creates a global IP whitelist template. |
| ModifyGlobalSecurityIPGroupName | ModifyGlobalSecurityIPGroupName | Modifies the name of a global IP whitelist template. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries information about the global IP whitelist templates associated with an instance. |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP whitelist template. |
| ModifyGlobalSecurityIPGroup | ModifyGlobalSecurityIPGroup | Modifies a global IP whitelist template. |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation | Adds a specified instance to a specified IP whitelist template. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Queries global IP whitelist templates. |
Parameter Template Management
| API | Title | Description |
|---|---|---|
| ModifyInstanceParameter | ModifyInstanceParameter | Applies a parameter template to specific instances. This indicates that the parameter values in the template take effect on the instances. After you modify a parameter template, you must reapply it to specific instances for the new parameter values to take effect on the instances. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a parameter template. |
| DescribeParameterGroupSupportParam | DescribeParameterGroupSupportParam | Queries the parameters that can be configured in parameter templates across different database versions. |
| DescribeParameterGroup | DescribeParameterGroup | Queries the basic information about a parameter template. |
| ModifyParameterGroup | ModifyParameterGroup | Modifies the settings of a parameter template. |
| DescribeParameterGroups | DescribeParameterGroups | Queries a list of available parameter templates. |
| CreateParameterGroup | CreateParameterGroup | Creates a parameter template. |
| DescribeParameterGroupTemplateList | DescribeParameterGroupTemplateList | Queries the information about the parameters that can be configured in a parameter template, such as the default values, value ranges, and descriptions. |
Event management
| API | Title | Description |
|---|---|---|
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the O\\\\\\\\\\&M event details of an instance. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Modifies the switching time of scheduled O\\\&M events for an instance. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels O\\\&M events at a time. |
| ModifyEventInfo | ModifyEventInfo | |
| DescribeHistoryEvents | DescribeHistoryEvents | DescribeHistoryEvents |
| DescribeHistoryEventsStat | DescribeHistoryEventsStat | Queries the statistics of historical events. |
Fault simulation
| API | Title | Description |
|---|---|---|
| SwitchInstanceZoneFailOver | SwitchInstanceZoneFailOver | Switches an instance from the current zone to the specified zone in the event of a fault. |
| MasterNodeShutDownFailOver | MasterNodeShutDownFailOver | Simulates database node failures. |
Other
| API | Title | Description |
|---|---|---|
| ModifyInstanceBandwidth | ModifyInstanceBandwidth | Sets the intended bandwidth value of a Tair (Redis OSS-compatible) instance. |
| ModifyTaskInfo | ModifyTaskInfo | Modifies the task information, such as the task execution time. |
| ModifyBackupExpireTime | ModifyBackupExpireTime | Extends the expiration time of manual backup data. |
| DeleteBackup | DeleteBackup | Deletes a specified backup set. However, you can delete only backup sets that are manually backed up. |
| CreateTairKVCacheVNode | CreateTairKVCacheVNode | Creates a Tair VNode instance. |
| DescribeTairKVCacheInferInstances | DescribeTairKVCacheInferInstances | Queries the information of one or more Tair (Redis OSS-compatible) KVCache instances. |
| TransformToEcs | TransformToEcs | Converts an instance use local disks to a cloud-native instance. |
| ModifyDBInstanceMonitor | ModifyDBInstanceMonitor | Modifies the monitoring granularity of a Tair (Redis OSS-compatible) instance. |
| DescribeTags | DescribeTags | Queries all tags in a region. |
| DescribeDbInstanceConnectivity | DescribeDbInstanceConnectivity | Checks the connectivity between the client IP address and the instance. |