全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

GET BucketMirror

最近更新时间:2022-12-30 15:48:03

描述

此接口返回源存储空间的镜像回源与重定向回源配置。

请求

语法

GET /?mirror HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}  

请求参数

该接口不使用请求参数。

请求头部

该接口只使用常用请求头部。获取更多信息,请点击常用请求头部

请求体

该接口不使用请求内容。

响应

响应头部

本接口只带有常用响应头部。获取更多信息,请点击常用响应头部

响应内容

返回一个json,可能有下列节点:

名称 描述 是否必选
bucketMirror 包含镜像回源规则的容器, 一个源存储空间
类型:Container
父节点:无
version 回源类型
类型: String
父节点:bucketMirror
有效值: V3
说明:只支持V3
use_default_robots 是否使用默认的robots.txt,如果为true则会在bucket下生成一个robots.txt。
类型:String
父节点:bucketMirror
有效值:true | false
async_mirror_rule 异步回源规则,该字段与sync_mirror_rules必须至少有一个,可同时存在。
类型: Container
父节点:bucketMirror
mirror_urls 一组源站url,数量不超过10个,url必须以http或者https开头,域名部分最多不超过256个字符,path部分最多不超过1024个字符。
类型:String
父节点:bucketMirror.async_mirror_rule
saving_setting 从源站回源得到的文件在上传ks3时的配置。
类型: Container
父节点:bucketMirror.async_mirror_rule | sync_mirror_rules
acl 文件上传KS3时,指定文件的权限。
类型: String
父节点: bucketMirror.async_mirror_rule.saving_setting
有效值:public-read |private
sync_mirror_rules 一组同步回源规则,最多可配置20个。该字段与async_mirror_rule必须至少有一个,可同时存在。
类型: Container
父节点:bucketMirror
match_condition 回源触发条件,可不填,不填表示对该bucket中不存在的object发送get请求时,将会触发回源。
类型:Container
父节点:bucketMirror.sync_mirror_rules
http_codes 触发回源的http状态码,目前仅支持404一种。
类型:String
父节点:bucket.Mirrorsync_mirror_rules.match_condition
有效值:404
key_prefixes 当请求的object key的前缀与任意一个key_prefix匹配时触发回源,仅支持一个前缀。
类型:String
父节点:bucketMirror.sync_mirror_rules.match_condition
mirror_url 源站url,必须以http或者https开头,域名部分最多不超过256个字符,path部分最多不超过1024个字符
类型:String
父节点:bucketMirror.sync_mirror_rules
mirror_request_setting ks3请求源站时的配置,可不填。
类型:Container
父节点:bucketMirror.sync_mirror_rules
pass_query_string ks3请求源站时是否将客户端请求ks3时的query string透传给源站。
类型:String
父节点:bucketMirror.sync_mirror_rules.mirror_request_setting
有效值:true | false
follow3xx 设置访问源站时,是否follow 302/301。
ks3是否响应源站的301和302跳转,如果为false且源站返回了302,则ks3会返回424给客户端,如果为true则ks3收到302后会请求302的location。
类型:String
父节点:bucketMirror. sync_mirror_rules.mirror_request_setting
有效值: true | false
header_setting ks3请求源站时的header配置,注意以下的属性有优先级:set_headers > remove_headers > pass_all > pass_headers。
类型:Container
父节点: bucketMirror.sync_mirror_rules.mirror_request_setting
set_headers 自定义header,这些header的key和value均是固定的,ks3请求源站时会带上这些header。
类型:String
父节点: bucketMirror.sync_mirror_rules.mirror_request_setting.header_setting
remove_headers 从客户端发给ks3的header中移除以下指定的header,通常与pass_all或者pass_headers配合使用,只能指定header中的key,不能指定value。
类型:String
父节点:bucketMirror.sync_mirror_rules.mirror_request_setting.header_setting
pass_all 将客户端发给ks3的header全部透传给源站,该字段与pass_headers互斥。
类型:String
父节点: bucketMirror.sync_mirror_rules.mirror_request_setting.header_setting
有效值: true | false
pass_headers 将客户端发给ks3的header中指定的几个透传给源站,只能指定header中的key,不能指定value。
类型:String
父节点:bucketMirror. sync_mirror_rules.mirror_request_setting.header_setting

示例

请求示例

GET /?mirror HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Authorization: authorization string
Date: Tue, 19 Jul 2016 09:12:54 GMT

响应示例

Bucket Mirror存在时:

HTTP/1.1 200 OK
Content-Length: 232
Content-Type: application/json; charset=UTF-8
Connection: keep-alive
Date: Tue, 19 Jul 2016 09:25:29 GMT
Server: KS3
X-Kss-Request-Id: 708e01a0b42642cd94611f33a2a96874
{
  "version": "V3",
  "use_default_robots": false,
  "sync_mirror_rules": [
    {
      "match_condition": {
        "http_codes": [
          "404"
        ],
        "key_prefixes": [
          "abc",
          "def"
        ]
      },
      "mirror_url": "http://v-ks-a-i.originalvod.com",
      "mirror_request_setting": {
        "pass_query_string": true,
        "follow3xx": true,
        "header_setting": {
          "set_headers": [
            {
              "key": "abc",
              "value": "def"
            }
          ],
          "remove_headers": [
            {
              "key": "asdb"
            },
            {
              "key": "asdfa"
            }
          ],
          "pass_headers": [
            {
              "key": "asdb"
            },
            {
              "key": "asdfa"
            }
          ]
        }
      },
      "saving_setting": {
        "acl": "private"
      }
    }
  ]
}

Bucket Mirror不存在时:

HTTP/1.1 404 Not Found
Content-Type: application/xml
Connection: keep-alive
Date: Tue, 19 Jul 2016 09:28:59 GMT
Server: KS3
X-Kss-Request-Id: 1f807bb266854e4487ce27857001ba38
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Error>
    <Code>NoSuchBucketMirror</Code>
    <Message>The bucket mirror does not exist.</Message>
    <Resource>/ks3-example/?mirror</Resource>
    <RequestId>1f807bb266854e4487ce27857001ba38</RequestId>
</Error>

错误码

错误码 HTTP状态码 描述
NoSuchBucketMirror 404 Not Found Bucket没有配置回源规则。
文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈