首批通过分布式安全可靠测评,为关键业务系统打造
ALTER/CHANGE/MODIFY EXTERNAL_STORAGE_DEST
更新时间:2026-04-16 13:11:33
描述
该语句用于修改本租户备份或归档路径的源端:zone、idc 或 region 配置。修改后,新的配置信息将会覆盖原来的配置信息。
使用限制及注意事项
对于 V4.2.1 版本,从 V4.2.1 BP11 版本开始支持该语句。
仅用户租户可以执行该语句,系统租户(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 的变化情况。修改备份路径的源端配置时,如果有备份任务正在执行,由于正在执行的任务至多需要分钟级时间才能感知到配置的变化,故在配置修改期间,仍可能会有配置范围外的节点访问备份路径,导致产生跨机房或跨地域的流量。
权限要求
执行该语句的用户需要拥有 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}';
参数说明
| 参数 | 描述 |
|---|---|
| path | 指定待修改配置的备份路径或归档路径。如果归档介质为对象存储类型,则还需要包含对象存储的主机地址、访问密钥等信息。例如,当归档介质为 OSS 时,该路径的格式为:oss://oceanbase-test-bucket/backup/databackup?host=xxxx |
| zone=zone_name | idc=idc_name | region=region_name | 指定当前备份路径或归档路径的源端。支持选择 zone、idc 或 region 三个不同层级的配置,只能同时选择一个层级或者不设置。如果不显式指定,则默认不设置。修改归档路径的源端配置时:
修改备份路径的源端配置时:
|
示例
修改归档路径的源端配置
假设归档路劲原来的源端配置为
zone=z1,z2,z3,现在需要将源端配置更改为region=region1。修改后,仅region1中的节点可以访问该路径。OSS
obclient> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/archive?host=****.aliyun-inc.com' SET ATTRIBUTE = 'region=region1';NFS
obclient> ALTER SYSTEM MODIFY EXTERNAL_STORAGE_DEST PATH='file:///data/nfs/backup/archive' SET ATTRIBUTE = 'region=region1';S3
obclient> 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> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=obs.****.myhuaweicloud.com' SET ATTRIBUTE = 'region=region1';obclient> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/archive?host=https://storage.googleapis.com' SET ATTRIBUTE = 'region=region1';obclient> ALTER SYSTEM CHANGE 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> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/data?host=****.aliyun-inc.com' SET ATTRIBUTE = 'idc=idc1;idc2';NFS
obclient> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='file:///data/nfs/backup/data' SET ATTRIBUTE = 'idc=idc1;idc2';S3
obclient> ALTER SYSTEM CHANGE 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> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=obs.****.myhuaweicloud.com' SET ATTRIBUTE = 'idc=idc1;idc2';obclient> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test-bucket/backup/data?host=https://storage.googleapis.com' SET ATTRIBUTE = 'idc=idc1;idc2';obclient> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='s3://oceanbase-test/backup/data?host=cos.ap-xxxx.myqcloud.com' SET ATTRIBUTE = 'idc=idc1;idc2';