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 (78410016550) 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 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 data shards to a cloud-native 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 an ApsaraDB for Redis cluster instance. |
| DeleteInstance | DeleteInstance | Releases a Tair (Redis OSS-compatible) instance. |
| ModifyInstanceSpec | ModifyInstanceSpec | Changes the configurations of a Tair (Redis OSS-compatible) instance. |
| DescribeRegions | DescribeRegions | Queries all regions and zones supported for a Redis instance. |
| 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 a pay-as-you-go Tair (Redis OSS-compatible) instance to a subscription instance. |
| MigrateToOtherZone | MigrateToOtherZone | Migrates a Tair (Redis OSS-compatible) instance across zones within the same region. |
Instance management
| API | Title | Description |
|---|---|---|
| CreateTairInstance | CreateTairInstance | Creates a Tair (Enterprise Edition) cloud-native instance. |
| CreateInstances | CreateInstances | Creates multiple ApsaraDB for Redis 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 | 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 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 ApsaraDB for Redis 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 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 | 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. |
| DescribeTasks | DescribeTasks | Queries all tasks that are performed on a Tair (Redis OSS-compatible) instance within a specified period of time. |
| 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 an ApsaraDB for Redis instance. |
| RestartInstance | RestartInstance | Restarts a running ApsaraDB for Redis 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 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 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. |
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 internal bandwidth of an ApsaraDB for Redis 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 an ApsaraDB for Redis 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 an ApsaraDB for Redis 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 an ApsaraDB for Redis 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 | Changes the password of a specific account for an ApsaraDB for Redis 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 an ApsaraDB for Redis instance. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the automatic backup policy of a Tair (Redis OSS-compatible) 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 | Queries the backup files of a Tair (Redis OSS-compatible) instance. |
| RestoreInstance | RestoreInstance | Restores the data in a specified backup file to a Tair (Redis OSS-compatible) instance. |
| DescribeClusterBackupList | DescribeClusterBackupList | Queries the backup sets of an ApsaraDB for Redis or Tair cluster instance. |
Monitoring management
| API | Title | Description |
|---|---|---|
| DescribeMonitorItems | DescribeMonitorItems | Queries the monitoring 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). |
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 a whitelist for a Tair (Redis OSS-compatible) instance. |
| ModifyInstanceSSL | ModifyInstanceSSL | Modifies the SSL settings of an ApsaraDB for Redis instance. |
| ModifyInstanceVpcAuthMode | ModifyInstanceVpcAuthMode | Enables or disables password-free access for a Tair (Redis OSS-compatible) instance. When the password-free access feature is enabled, Elastic Compute Service (ECS) instances in the same virtual private cloud (VPC) can connect to the Tair (Redis OSS-compatible) instance without using a password. You can also use the username and password to connect to the Tair (Redis OSS-compatible) instance. |
| 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 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 Tair (Redis OSS-compatible) 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 (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 |
|---|---|---|
| DescribeHistoryTasks | DescribeHistoryTasks | Queries a list of tasks in the task center. |
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. |
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. |