ALTER/CHANGE/MODIFY EXTERNAL_STORAGE_DEST

描述

该语句用于变更本租户备份或归档路径的源端配置（zone、idc 或 region 配置）、I/O 限流参数（max_iops 和 max_bandwidth）以及 access_id 和 access_key 等密钥信息。修改后，新的配置信息将会覆盖原来的配置信息。

使用限制及注意事项

• 仅用户租户可以执行该语句，系统租户（sys 租户）不能执行该语句。

• 修改路径的 zone、idc 或 region 配置前，如果需要设置 Region 层级或 IDC 层级，需要先通过 ALTER SYSTEM MODIFY ZONE zone_name SET REGION=region_name; 或 ALTER SYSTEM MODIFY ZONE zone_name SET IDC=idc_name; 语句分别设置 Region 信息或 IDC 信息。推荐设置 IDC 层级的源端配置，利用有较多网络带宽资源的 IDC 来执行备份任务的同时，备份任务有更多的可选节点范围，同时用户也不需要关注集群中 IDC 内 Zone 的变化情况。

• 修改备份路径的源端配置时，如果有备份任务正在执行，由于正在执行的任务至多需要分钟级时间才能感知到配置的变化，故在配置修改期间，仍可能会有配置范围外的节点访问备份路径，导致产生跨机房或跨地域的流量。

• 仅对象存储路径支持变更 I/O 限流参数（max_iops 和 max_bandwidth） 以及 access_id 和 access_key 信息。如果备份介质为 NFS 的路径设置 I/O 限流参数（max_iops 和 max_bandwidth）或者 access_id、access_key 信息，系统会返回不支持的错误，错误码为 1235。

• 为对象存储路径设置 ACCESS_INFO 属性（access_id 和 access_key 信息）时，如果参数的格式不正确（例如，有多余的 =、缺少 access_id 或 access_key），系统会报错 OB_OBJECT_STORAGE_PERMISSION_DENIED（错误码为 -9116）。

• 备份路径或归档路径使用 Assume Role 方式访问对象路径时：

  • 如果设置 ACCESS_INFO = 'access_id=new_access_id&access_key=new_access_key'，系统会报错。

  • 如果仅设置 ATTRIBUTE 中的 I/O 限流参数（不设置 ACCESS_INFO 属性），系统可能提示不支持或者设置后不生效。

• 允许为同一路径多次设置相同的 ATTRIBUTE + ACCESS_INFO 属性。

权限要求

执行该语句的用户需要拥有 ALTER SYSTEM 权限。有关 OceanBase 数据库权限的详细介绍，参见 MySQL 模式下的权限分类。

语法

ALTER SYSTEM {ALTER|CHANGE|MODIFY} EXTERNAL_STORAGE_DEST 
  PATH [=] 'path' 
  SET [ATTRIBUTE = '[{zone=zone_name | idc=idc_name | region=region_name}][&max_iops=iops_num][&max_bandwidth=bandwidth_num]']
  [ACCESS_INFO = 'access_id=new_access_id&access_key=new_access_key'];

参数说明

示例

修改归档路径的源端配置

假设归档路劲原来的源端配置为 zone=z1,z2,z3，现在需要将源端配置更改为 region=region1。修改后，仅 region1 中的节点可以访问该路径。

• OSS

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/archive?host=****.aliyun-inc.com' SET ATTRIBUTE = 'region=region1';
  

• NFS

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='file:///data/nfs/backup/archive' SET ATTRIBUTE = 'region=region1';
  

• S3

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=s3.<region>.amazonaws.com' SET ATTRIBUTE = 'region=region1';
  

• 兼容 S3 协议的对象存储（OBS/GCS/COS）

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=obs.****.myhuaweicloud.com' SET ATTRIBUTE = 'region=region1';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=https://storage.googleapis.com' SET ATTRIBUTE = 'region=region1';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM ALTER EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=cos.ap-xxxx.myqcloud.com' SET ATTRIBUTE = 'region=region1';
  

修改备份路径的源端配置

假设备份路径原来的源端配置为 zone=z1,z2;z3，现在需要将源端配置更改为 idc=idc1;idc2。修改后，idc1、idc2 中的节点可以访问该路径，且idc1 的优先级高于 idc2。

• OSS

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/data?host=****.aliyun-inc.com' SET ATTRIBUTE = 'idc=idc1;idc2';
  

• NFS

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='file:///data/nfs/backup/data' SET ATTRIBUTE = 'idc=idc1;idc2';
  

• S3

  obclient(root@mysql001)[(none)]> ALTER SYSTEM ALTER EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=s3.<region>.amazonaws.com' SET ATTRIBUTE = 'idc=idc1;idc2';
  

• 兼容 S3 协议的对象存储（OBS/GCS/COS）

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=obs.****.myhuaweicloud.com' SET ATTRIBUTE = 'idc=idc1;idc2';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=https://storage.googleapis.com' SET ATTRIBUTE = 'idc=idc1;idc2';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM ALTER EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test/backup/data?host=cos.ap-xxxx.myqcloud.com' SET ATTRIBUTE = 'idc=idc1;idc2';
  

变更归档路径的 access_id 和 access_key 信息

• OSS

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/archive?host=****.aliyun-inc.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

• S3

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=s3.<region>.amazonaws.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

• 兼容 S3 协议的对象存储（OBS/GCS/COS）

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=obs.****.myhuaweicloud.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=https://storage.googleapis.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM ALTER EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=cos.ap-xxxx.myqcloud.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

变更备份路径的 access_id 和 access_key 信息

• OSS

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/data?host=****.aliyun-inc.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

• S3

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=s3.<region>.amazonaws.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

• 兼容 S3 协议的对象存储（OBS/GCS/COS）

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=obs.****.myhuaweicloud.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=https://storage.googleapis.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM ALTER EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test/backup/data?host=cos.ap-xxxx.myqcloud.com' SET ACCESS_INFO = 'access_id=******&access_key=******';
  

设置归档路径的 I/O 限流参数（max_iops 和 max_bandwidth）

可以同时设置 max_iops 和 max_bandwidth 参数，也可以单独设置 max_iops 或 max_bandwidth 参数。仅对象存储路径支持设置，NFS 路径不支持设置 I/O 限流参数。

• OSS

  同时设置 max_iops 和 max_bandwidth 参数，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/archive?host=****.aliyun-inc.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

  单独设置 max_iops，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/archive?host=****.aliyun-inc.com' SET ATTRIBUTE = 'max_iops=1000';
  

  单独设置 max_bandwidth，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/archive?host=****.aliyun-inc.com' SET ATTRIBUTE = 'max_bandwidth=1000mb';
  

• S3

  同时设置 max_iops 和 max_bandwidth 参数，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=s3.<region>.amazonaws.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

• 兼容 S3 协议的对象存储（OBS/GCS/COS）

  同时设置 max_iops 和 max_bandwidth 参数，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=obs.****.myhuaweicloud.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=https://storage.googleapis.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM ALTER EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=cos.ap-xxxx.myqcloud.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

设置备份路径的 I/O 限流参数（max_iops 和 max_bandwidth）

可以同时设置 max_iops 和 max_bandwidth 参数，也可以单独设置 max_iops 或 max_bandwidth 参数。仅对象存储路径支持设置，NFS 路径不支持设置 I/O 限流参数。

• OSS

  同时设置 max_iops 和 max_bandwidth 参数，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/data?host=****.aliyun-inc.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

  单独设置 max_iops，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/data?host=****.aliyun-inc.com' SET ATTRIBUTE = 'max_iops=1000';
  

  单独设置 max_bandwidth，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/data?host=****.aliyun-inc.com' SET ATTRIBUTE = 'max_bandwidth=1000mb';
  

• S3

  同时设置 max_iops 和 max_bandwidth 参数，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=s3.<region>.amazonaws.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

• 兼容 S3 协议的对象存储（OBS/GCS/COS）

  同时设置 max_iops 和 max_bandwidth 参数，示例如下。

  obclient(root@mysql001)[(none)]> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=obs.****.myhuaweicloud.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM ALTER EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=https://storage.googleapis.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

  obclient(root@mysql001)[(none)]> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test/backup/data?host=cos.ap-xxxx.myqcloud.com' SET ATTRIBUTE = 'max_iops=1000&max_bandwidth=1000mb';
  

相关文档

• 修改备份路径的源端配置

• 备份路径和归档路径源端配置案例

• 更新对象存储的密钥信息