搜索本产品文档关键词
PutBucketMirroring
所有文档
menu

BOS 对象存储

PutBucketMirroring

接口描述

本接口用来创建镜像回源管理规则。

注意:

  • 只有bucket的owner且拥有FULL_CONTROL权限才能够进行此请求。
  • PutBucketMirroring会覆盖原有的镜像回源规则, 如果需要在原有规则基础上新增, 需要在请求中携带所有新旧规则。

请求(Request)

  • 请求语法

    Plain Text
    1PUT /?mirroring HTTP/1.1
    2Host: <BucketName>.bj.bcebos.com
    3x-bce-date: date
    4Content-Length: request-body length
    5Content-Type: application/json; charset=utf-8
    6Authorization: AuthorizationString
    7{
    8   "bucketMirroringConfiguration":[
    9         {
    10               "mode":"fetch", 						
    11               "sourceUrl":"http://www.baidu.com", 
    12               "backSourceUrl":"bos://bj.bcebos.com/bucket",   
    13               "resource" : "folder1/folder2*.jpeg",  
    14               "prefix": "testprefix",					
    15               "suffix": ".jpeg",						
    16               "fixedKey":"folder1/404.jpeg", 
    17               "version":"v2", 							
    18               "prefixReplace" : "a/b/c",			
    19               "passQuerystring":true,					
    20               "storageClass":"STANDARD",				
    21               "customHeaders":[
    22                   {
    23                       "headerName":"testheader1",
    24                       "headerValue":"name1",
    25                   },
    26                   {
    27                       "headerName":"TestHeaderName",
    28                       "headerValue":"TestHeaderValue",
    29                   }			
    30               ],
    31               "ignoreHeaders": ["BanHeader1","BanHeader2"],
    32               "passHeaders":["AllowHeader1","AllowHeader2"], //若设置为["*"],则表示透传所有header
    33          },
    34     ]
    35}
  • 请求头域

    无特殊参数

  • 请求参数

    规则项
    描述
    是否必须
    备注
    数据类型
    bucketMirroringConfiguration 容器 镜像回源规则的容器 列表
    mode 模式为回源或者重定向 可选值 fetch(回源),redirect(重定向) 字符串
    sourceUrl 主源站url 主源站回源地址,如果选择私有bucket,则传入以下信息 "bos://endpoint/bucket", 否则传入用户手动输入的url 字符串
    backSourceUrl 备源站url 规则与主源站url相同 字符串
    resource 规则对哪些资源生效 回源条件中的前后缀,以*分割, "folder1/folder2"代表回源条件前缀,".jpeg"代表回源条件后缀 。 字符串
    prefix 回源地址前缀 源站前缀 字符串
    suffix 回源地址后缀 例如当配置为.docx时,回源object名称将被自动扩展为myobject.docx 字符串
    fixedKey 回源地址固定名称 当fixedKey有传入且不为空时,则回源到固定名称,此时忽略源站前后缀prefix,suffix,前后缀替换等场景,回源地址为sourceUrl+fixedKey 字符串
    version 回源前缀替换选项 version为空默认v1,代表老版本配置,老版本prefixReplace为""时,代表不对objectname中的路径前缀进行操作,新版本为v2,代表启用object前缀替换,此时传入""代表对路径前缀进行裁剪 字符串
    prefixReplace 前缀替换裁剪选项 仅当version为v2时生效,传入非空字符串则代表进行前缀替换,将"path1/path2/objectname"替换为"a/b/c/objectname",传入空字符串则代表进行前缀裁剪,"path1/path2/objectname"替换为"objectname" 字符串
    passQuerystring 是否传递请求参数 可选值true或false,默认false bool
    storageClass 回源的存储类型 fetch模式下回源存储类型,例如STANDARD 字符串
    passHeaders 透传的header 请求源站时将透传的header,若设置为["*"]则表示透传全部header 列表
    ignoreHeaders 忽略的header 请求源站时将忽略的header 列表
    customHeaders 自定义header 请求源站时自定义携带的header 列表

响应(Response)

  • 响应示例

    Plain Text
    1 HTTP/1.1 200 OK
    2 x-bce-request-id: 0A49CE4060975EAC
    3 Date: Wed, 12 Oct 2016 17:50:00 GMT
    4 Content-Length: 0
    5 Connection: keep-alive
    6 Server: BceBos
上一篇
额度管理
下一篇
GetBucketMirroring