All Products
Search

This Product

    Tair (Redis® OSS-Compatible):Notice on change in the DescribeBackups and DescribeBackupTasks operations

    Document Center

    Tair (Redis® OSS-Compatible):Notice on change in the DescribeBackups and DescribeBackupTasks operations

    Last Updated:Oct 25, 2024

    To improve user experience, Tair（Redis OSS-compatible） SDKs are upgraded on March 30, 2024. The new versions involve the compatibility improvements of the DescribeBackups and DescribeBackupTasks operations. To prevent impacts on your business, we recommend that you upgrade the SDK versions at the earliest opportunity.

    Effective from

    March 30, 2024

    Content

    The new versions of Tair（Redis OSS-compatible） SDKs change the data types of the BackupJobId and BackupId parameters in the DescribeBackups and DescribeBackupTasks operations and increase the number of digits allowed in the parameter values. For example, in the new versions of SDK for Java, the data types of the parameters are changed from Integer to Long.

    Note

    For information about the programming languages supported by Tair（Redis OSS-compatible） SDKs and how to install dependencies, see ApsaraDB for Redis SDKs.

    Impacts

    The DescribeBackups and DescribeBackupTasks operations that are called through the SDKs released before March 30, 2024 may fail if the BackupJobId or BackupId parameter is specified.

    Suggestions

    Upgrade the SDKs to versions that are released on or after March 30, 2024. Upgrade the SDK for Java asynchronous client to 2.0.0 or later, SDK for Go to 4.0.0 or later, and SDKs for Java and other programming languages to 3.0.0 or later.

    Modification examples:

    • Java: The data types of the BackupJobId and BackupId parameters are changed from Integer to Long. 

      ...
        com.aliyun.r_kvstore20150101.models.DescribeBackupTasksResponse resp = new com.aliyun.r_kvstore20150101.models.DescribeBackupTasksResponse();
        for (DescribeBackupTasksResponseBody.DescribeBackupTasksResponseBodyBackupJobs job :  resp.getBody().getBackupJobs()) {
            // After you upgrade the SDKs to the latest version, if you set the two parameters to Integer or Long values, errors are reported when you compile or package your program.
            // You can modify your business code based on the data types of the values of response parameters.
            Long backupJobID = job.getBackupJobID();
     }
...

    • Golang: The data types of the BackupJobId and BackupId parameters are changed from Int32 to Int64.

    • Other programming languages: You can modify your business code based on the sample code for Java and the data types of the request and response parameters defined in the SDKs.

    References