Update `access_id` and `access_key` information for the backup or archive path

OceanBase Database supports dynamically updating the access_id and access_key information for backup paths or archive paths. After configuring the backup path or archive path, if the user changes the key information of the object storage for security or other reasons, this method can be used to update the access_id and access_key for the already configured backup path or archive path to ensure the normal execution of backups or archiving.

Limitations

• Only the access_id and access_key information of object storage paths can be updated.

• Only user tenants are allowed to update the key information of their own backup paths or archive paths. System tenants are not allowed to update the key information of backup paths or archive paths for specific user tenants.

Considerations

• During the backup or archiving process, if the key information corresponding to the object storage path is changed, the access_id and access_key information for the backup path or archive path must be updated promptly. Failure to do so may result in backup task execution failures or issues with archiving progress.

• In physical standby scenarios based on log archiving, if the key information corresponding to the object storage path is changed, the access_id and access_key information in the log restore path of the standby database (standby tenant) must be updated as soon as possible. Otherwise, it may cause issues with log synchronization progress. For detailed steps on updating the access_id and access_key information in the log restore path of the standby database (standby tenant), see Set the log restore source.

Procedure

1. Log in to the user tenant of the cluster as the tenant administrator of the user tenant.

   Note

   In MySQL-compatible mode, the administrator user is the root user, and in Oracle-compatible mode, the administrator user is the SYS user.

   An example of the connection is shown below. Connect to the database based on your actual environment.

   obclient -h10.xx.xx.xx -P2883 -uroot@mysql_tenant#obdemo -p***** -A
   

2. Execute the following statement to change the key information of the backup path or archive path.

   The sample SQL statement is as follows:

   ALTER SYSTEM {ALTER|CHANGE|MODIFY} EXTERNAL_STORAGE_DEST PATH [=] 'path' SET ACCESS_INFO = 'access_id=new_access_id&access_key=new_access_key';
   

   The parameters in the statement are described as follows:

   • path: the backup path or archive path for which the key information is to be updated. The path must be a backup path or archive path already configured for the current tenant, and it must be an object storage path. Additionally, the path must include the host information.

     For example, in the case of OSS, the path format is as follows: oss://oceanbase-test-bucket/backup/data?host=***.

   • access_id=new_access_id&access_key=new_access_key: the new access_id and access_key after the update. You must specify both access_id and access_key.

   For example, assuming that the backup path and archive path configured for the current user tenant during backup are oss://oceanbase-test-bucket/backup/data?host=cn-****.aliyuncs.com and oss://oceanbase-test-bucket/backup/archive?host=cn-****.aliyuncs.com respectively, the key information of the backup path and archive path can be updated as follows:

   • Update the key information of the backup path

     obclient> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/data?host=cn-****.aliyuncs.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
     

   • Update the key information of the archive path

     obclient> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/archive?host=cn-****.aliyuncs.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
     

   For more information, see ALTER/CHANGE/MODIFY EXTERNAL_STORAGE_DEST.

3. Query the DBA_OB_BACKUP_STORAGE_INFO view to confirm the change.

   MySQL-compatible mode

   Oracle-compatible mode

   • Confirm the access_id and access_key of the backup path.

     obclient[oceanbase]> SELECT AUTHORIZATION FROM oceanbase.DBA_OB_BACKUP_STORAGE_INFO WHERE PATH='oss://oceanbase-test-bucket/backup/data' AND ENDPOINT = 'host=cn-****.aliyuncs.com';
     

     The query result is as follows:

     +-------------------------------------+
     | AUTHORIZATION                       |
     +-------------------------------------+
     | access_id=******&encrypt_key=****** |
     +-------------------------------------+
     1 row in set
     

   • Confirm the access_id and access_key of the archive path.

     obclient[oceanbase]> SELECT AUTHORIZATION FROM oceanbase.DBA_OB_BACKUP_STORAGE_INFO WHERE PATH='oss://oceanbase-test-bucket/backup/archive' AND ENDPOINT = 'host=cn-****.aliyuncs.com';
     

     The query result is as follows:

     +-------------------------------------+
     | AUTHORIZATION                       |
     +-------------------------------------+
     | access_id=******&encrypt_key=****** |
     +-------------------------------------+
     1 row in set
     

   • Confirm the access_id and access_key of the backup path.

     obclient[SYS]> SELECT AUTHORIZATION FROM SYS.DBA_OB_BACKUP_STORAGE_INFO WHERE PATH='oss://oceanbase-test-bucket/backup/data' AND ENDPOINT = 'host=cn-****.aliyuncs.com';
     

     The query result is as follows:

     +-------------------------------------+
     | AUTHORIZATION                       |
     +-------------------------------------+
     | access_id=******&encrypt_key=****** |
     +-------------------------------------+
     1 row in set
     

   • Confirm the access_id and access_key of the archive path.

     obclient[SYS]> SELECT AUTHORIZATION FROM SYS.DBA_OB_BACKUP_STORAGE_INFO WHERE PATH='oss://oceanbase-test-bucket/backup/archive' AND ENDPOINT = 'host=cn-****.aliyuncs.com';
     

     The query result is as follows:

     +-------------------------------------+
     | AUTHORIZATION                       |
     +-------------------------------------+
     | access_id=******&encrypt_key=****** |
     +-------------------------------------+
     1 row in set
     

References

• View parameters for data backup

• View parameters for data archiving

• ALTER/CHANGE/MODIFY EXTERNAL_STORAGE_DEST