All Products
Search
Document Center

Tair:List of operations by function

Last Updated:Apr 23, 2024
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

APITitleDescription
CreateInstanceCreateInstanceCreates an ApsaraDB for Redis instance.
AddShardingNodeAddShardingNodeAdds one or more data shards to an ApsaraDB for Redis cluster instance.
CreateGlobalDistributeCacheCreateGlobalDistributeCacheConverts an existing ApsaraDB for Redis instance to the first child instance of a distributed ApsaraDB for Redis instance.
DeleteShardingNodeDeleteShardingNodeRemoves one or more data shards from an ApsaraDB for Redis cluster instance.
DeleteInstanceDeleteInstanceRelease the Redis instance.
ModifyInstanceSpecModifyInstanceSpecChanges the specifications of an ApsaraDB for Redis instance.
DescribeRegionsDescribeRegionsQueries the regions in which ApsaraDB for Redis instances can be created.
DescribeZonesDescribeZonesQueries the zones available for ApsaraDB for Redis.
DescribeAvailableResourceDescribeAvailableResourceQueries the types of ApsaraDB for Redis instances that can be created in a specified zone.
TransformToPrePaidTransformToPrePaidChanges the billing method of an ApsaraDB for Redis instance from pay-as-you-go to subscription.
MigrateToOtherZoneMigrateToOtherZoneMigrates an ApsaraDB for Redis instance to another zone in the same region.

Instance management

APITitleDescription
CreateTairInstanceCreateTairInstanceCreates a Tair instance.
CreateInstancesCreateInstancesCreates multiple ApsaraDB for Redis instances at a time.
EnableAdditionalBandwidthEnableAdditionalBandwidthAdjusts the bandwidth of an ApsaraDB for Redis instance.
ModifyInstanceAttributeModifyInstanceAttributeChanges the information of an ApsaraDB for Redis instance, such as the name and password.
ModifyResourceGroupModifyResourceGroupChanges the resource group to which an ApsaraDB for Redis instance belongs.
ModifyInstanceMaintainTimeModifyInstanceMaintainTimeModifies the maintenance window of an ApsaraDB for Redis instance. Alibaba Cloud maintains ApsaraDB for Redis instances during the specified maintenance window.
ModifyInstanceMajorVersionModifyInstanceMajorVersionUpgrades the major version of an ApsaraDB for Redis instance.
ModifyInstanceMinorVersionModifyInstanceMinorVersionUpdates the minor version of an ApsaraDB for Redis instance.
DescribeInstancesOverviewDescribeInstancesOverviewQueries the overview information of one or more ApsaraDB for Redis instances.
DescribeInstancesDescribeInstancesQueries the information about one or more ApsaraDB for Redis instances.
DescribeInstanceAttributeDescribeInstanceAttributeQueries the details of an ApsaraDB for Redis instance.
DescribeGlobalDistributeCacheDescribeGlobalDistributeCacheQueries the details of a distributed ApsaraDB for Redis instance.
DescribeEngineVersionDescribeEngineVersionQueries the major version and minor version of an ApsaraDB for Redis instance and the release notes for minor versions.
DescribeRoleZoneInfoDescribeRoleZoneInfoQueries the role, type, minor version, and zone of each node in an ApsaraDB for Redis instance.
DescribeClusterMemberInfoDescribeClusterMemberInfoQueries the configuration information of nodes in an ApsaraDB for Redis cluster instance, such as specifications and the maximum number of connections.
DescribeTasksDescribeTasksQueries all tasks that are performed on an ApsaraDB for Redis instance within a specified period of time.
DescribeDBInstanceNetInfoDescribeDBInstanceNetInfoQueries the network information of an ApsaraDB for Redis instance.
DescribeLogicInstanceTopologyDescribeLogicInstanceTopologyQueries the logical topology of an ApsaraDB for Redis instance.
RestartInstanceRestartInstanceRestarts a running ApsaraDB for Redis instance.
FlushExpireKeysFlushExpireKeysDeletes the expired keys from an ApsaraDB for Redis instance.
FlushInstanceFlushInstanceClears the data of an ApsaraDB for Redis instance. The cleared data cannot be restored.
SwitchInstanceHASwitchInstanceHAPerforms 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.
SyncDtsStatusSyncDtsStatusDisables 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.
RemoveSubInstanceRemoveSubInstanceRemoves a child instance from a distributed instance.

Connection management

APITitleDescription
ModifyInstanceNetExpireTimeModifyInstanceNetExpireTimeExtends 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.
ModifyDBInstanceConnectionStringModifyDBInstanceConnectionStringChanges the endpoint or port number of an ApsaraDB for Redis instance.
ModifyIntranetAttributeModifyIntranetAttributeTemporarily adjusts the internal bandwidth of an ApsaraDB for Redis instance that is deployed in a dedicated cluster.
DescribeIntranetAttributeDescribeIntranetAttributeQueries 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.
SwitchNetworkSwitchNetworkChanges 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.
AllocateInstancePublicConnectionAllocateInstancePublicConnectionApplies for a public endpoint for an ApsaraDB for Redis instance.
ReleaseInstancePublicConnectionReleaseInstancePublicConnectionReleases the public endpoint of an ApsaraDB for Redis instance.
AllocateDirectConnectionAllocateDirectConnectionApplies for a private endpoint for an ApsaraDB for Redis cluster instance.
ReleaseDirectConnectionReleaseDirectConnectionReleases the private endpoint of an ApsaraDB for Redis cluster instance.
SwitchInstanceProxySwitchInstanceProxyEnables or disables the proxy mode for an ApsaraDB for Redis cluster instance in a dedicated cluster.

Renewal management

APITitleDescription
ModifyInstanceAutoRenewalAttributeModifyInstanceAutoRenewalAttributeEnables or disables auto-renewal for an ApsaraDB for Redis instance.
DescribePriceDescribePriceQueries the fees that you must pay when you create, upgrade, or renew an ApsaraDB for Redis instance.
DescribeInstanceAutoRenewalAttributeDescribeInstanceAutoRenewalAttributeQueries whether auto-renewal is enabled for an ApsaraDB for Redis instance.
RenewAdditionalBandwidthRenewAdditionalBandwidthRenews the purchased bandwidth for an ApsaraDB for Redis instance.
TransformInstanceChargeTypeTransformInstanceChargeTypeChanges the billing method of an ApsaraDB for Redis instance from subscription to pay-as-you-go or from pay-as-you-go to subscription.
RenewInstanceRenewInstanceRenews an ApsaraDB for Redis instance.

Account management

APITitleDescription
CreateAccountCreateAccountCreates an account that has specific permissions for an ApsaraDB for Redis instance.
DeleteAccountDeleteAccountDeletes an account from an ApsaraDB for Redis instance.
ModifyAccountDescriptionModifyAccountDescriptionModifies the description of an account for an ApsaraDB for Redis instance.
ModifyAccountPasswordModifyAccountPasswordChanges the password of a specific account for an ApsaraDB for Redis instance.
DescribeAccountsDescribeAccountsQueries all accounts or a specified account of an ApsaraDB for Redis instance.
ResetAccountPasswordResetAccountPasswordResets the password of an account for an ApsaraDB for Redis instance.
GrantAccountPrivilegeGrantAccountPrivilegeModifies the permissions of an account for an ApsaraDB for Redis instance.

Backup and restoration

APITitleDescription
CreateBackupCreateBackupBacks up an ApsaraDB for Redis instance.
ModifyBackupPolicyModifyBackupPolicyModifies the automatic backup policy of an ApsaraDB for Redis instance.
DescribeBackupTasksDescribeBackupTasksQueries the states of backup tasks for an ApsaraDB for Redis instance.
DescribeBackupPolicyDescribeBackupPolicyQueries the backup policy of an ApsaraDB for Redis instance, including the backup cycle and backup time.
DescribeBackupsDescribeBackupsQueries the backup files of the ApsaraDB for Redis instance.
RestoreInstanceRestoreInstanceRestores the data in a backup file to a specified ApsaraDB for Redis instance.

Monitoring management

APITitleDescription
DescribeMonitorItemsDescribeMonitorItemsQueries the metrics of an ApsaraDB for Redis instance.
DescribeHistoryMonitorValuesDescribeHistoryMonitorValuesQueries the performance monitoring data of an ApsaraDB for Redis instance.

Log management

APITitleDescription
ModifyAuditLogConfigModifyAuditLogConfigModifies the audit log settings of an ApsaraDB for Redis instance.
DescribeAuditLogConfigDescribeAuditLogConfigQueries 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.
DescribeAuditRecordsDescribeAuditRecordsQueries the audit logs of an ApsaraDB for Redis instance.
DescribeRunningLogRecordsDescribeRunningLogRecordsQueries the active logs of an ApsaraDB for Redis instance.
DescribeSlowLogRecordsDescribeSlowLogRecordsQueries the slow logs of an ApsaraDB for Redis instance that are generated within a specified period of time.
InitializeKvstorePermissionInitializeKvstorePermissionAssigns a service-linked role to ApsaraDB for Redis.

Network security

APITitleDescription
ModifySecurityIpsModifySecurityIpsModifies the IP address whitelists of an ApsaraDB for Redis instance.
ModifySecurityGroupConfigurationModifySecurityGroupConfigurationResets the security groups that are added to the whitelists of an ApsaraDB for Redis instance.
ModifyInstanceSSLModifyInstanceSSLModifies the SSL settings of an ApsaraDB for Redis instance.
ModifyInstanceVpcAuthModeModifyInstanceVpcAuthModeEnables 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.
DescribeSecurityIpsDescribeSecurityIpsQueries the IP address whitelists of an ApsaraDB for Redis instance.
DescribeSecurityGroupConfigurationDescribeSecurityGroupConfigurationQueries the security groups that are added to the whitelists of an ApsaraDB for Redis instance.
DescribeInstanceSSLDescribeInstanceSSLQueries whether SSL encryption is enabled for an ApsaraDB for Redis instance.

Parameter management

APITitleDescription
ModifyInstanceConfigModifyInstanceConfigModifies the parameter settings of an ApsaraDB for Redis instance.
DescribeParameterTemplatesDescribeParameterTemplatesQueries the parameters and their default values that are supported by ApsaraDB for Redis instances of different architectures and major versions.
DescribeInstanceConfigDescribeInstanceConfigQueries the parameter settings of an ApsaraDB for Redis instance.
DescribeParametersDescribeParametersQueries the configuration parameters and running parameters of an ApsaraDB for Redis instance.
DescribeParameterModificationHistoryDescribeParameterModificationHistoryQueries the parameter modification history of a Tair or ApsaraDB for Redis instance.

Tag management

APITitleDescription
ListTagResourcesListTagResourcesQueries the relationships between ApsaraDB for Redis instances and tags.
TagResourcesTagResourcesAdds specified tags to one or more ApsaraDB for Redis instances.
UntagResourcesUntagResourcesRemoves tags from one or more ApsaraDB for Redis instances.

Performance improvements

APITitleDescription
CreateCacheAnalysisTaskCreateCacheAnalysisTaskManually creates a cache analysis task.
DescribeCacheAnalysisReportDescribeCacheAnalysisReportQueries the cache analytics report that is generated on a specified date for an ApsaraDB for Redis instance.
DescribeCacheAnalysisReportListDescribeCacheAnalysisReportListQueries the cache analytics reports of an ApsaraDB for Redis instance.

TDE

APITitleDescription
ModifyInstanceTDEModifyInstanceTDEEnables transparent data encryption (TDE) for an ApsaraDB for Redis instance. You can use existing custom keys.
DescribeInstanceTDEStatusDescribeInstanceTDEStatusQueries whether transparent data encryption (TDE) is enabled for an ApsaraDB for Redis instance.
DescribeEncryptionKeyListDescribeEncryptionKeyListQueries the custom keys used by an ApsaraDB for Redis instance.
DescribeEncryptionKeyDescribeEncryptionKeyQueries the details of a custom key for an ApsaraDB for Redis instance to use Transparent Data Encryption (TDE).
CheckCloudResourceAuthorizedCheckCloudResourceAuthorizedQueries whether an ApsaraDB for Redis instance is authorized to use Key Management Service (KMS).

O\&M task management

APITitleDescription
ModifyActiveOperationTaskModifyActiveOperationTaskChanges the scheduled switchover time of an O\&M task.
DescribeActiveOperationTaskDescribeActiveOperationTaskQueries the detailed information about O\&M tasks of an ApsaraDB for Redis instance.

APITitleDescription
CreateGlobalSecurityIPGroupCreateGlobalSecurityIPGroupCreates a global IP whitelist template.
ModifyGlobalSecurityIPGroupNameModifyGlobalSecurityIPGroupNameModifies the name of a global IP whitelist template.
DescribeGlobalSecurityIPGroupRelationDescribeGlobalSecurityIPGroupRelationQueries information about the global IP whitelist templates associated with an instance.
DeleteGlobalSecurityIPGroupDeleteGlobalSecurityIPGroupDeletes a global IP whitelist template.
ModifyGlobalSecurityIPGroupModifyGlobalSecurityIPGroupModifies a global IP whitelist template.
ModifyGlobalSecurityIPGroupRelationModifyGlobalSecurityIPGroupRelationAdds a specified instance to a specified IP whitelist template.
DescribeGlobalSecurityIPGroupDescribeGlobalSecurityIPGroupQueries global IP whitelist templates.

Other

APITitleDescription
DescribeDedicatedClusterInstanceListDescribeDedicatedClusterInstanceListQueries the information of an ApsaraDB for Redis instance deployed in a dedicated cluster.
DescribeHistoryTasksDescribeHistoryTasksQueries a list of tasks in the task center.
FlushInstanceForDBFlushInstanceForDBCleans the data of specified databases in an instance.
UnlockDBInstanceWriteUnlockDBInstanceWriteUnlocks a write-locked instance. After the instance is unlocked, you can read and write data to and from the instance.
LockDBInstanceWriteLockDBInstanceWriteLocks an instance. After the instance is locked, you can only read data from the instance, but cannot write data to the instance.
DescribeClusterBackupListDescribeClusterBackupListQueries the backup sets of an ApsaraDB for Redis or Tair cluster instance.
DescribeDBNodeDirectVipInfoDescribeDBNodeDirectVipInfoQueries the information about virtual IP addresses (VIPs) of child instances of a cluster instance in direct connection mode.