获取桶的镜像回源规则GetBucketMirrorBackToSource_桶的高级配置

华为云计算云知识获取桶的镜像回源规则GetBucketMirrorBackToSource

普惠上云 HECS云服务器-1核2G1M

39元/年

云服务器新品 X实例-4核8G5M

288元/年

GeminiDB Redis 4GB 游戏广告

19元/年

网站搭建买3年送2年

1元/天

获取桶的镜像回源规则GetBucketMirrorBackToSource

时间: 2023-08-16 14:41:30

API网关云服务器云主机云计算弹性伸缩

猜你想看：

华为云耀L实例实时语音识别云服务器配置 CDN是什么意思视频点播加速什么是云桌面

接口说明

本接口用于查询指定桶的镜像回源策略。若策略存在,则返回成功,status code返回值为200。

URL

GET https://obs.cn-north-4.myhuaweicloud.com/

请求参数

名称	类型	IN	必选	描述
Authorization	string	header	是	请求消息中可带的签名信息。
Date	string	header	否	请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。默认值:无。条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。
bucket_name	string	query	是	请求的桶名称。
mirrorBackToSource	string	query	是	mirrorBackToSource表示请求桶的镜像回源规则API。

返回参数

返回码: 200

请求成功响应消息。

名称	类型	必选	描述
Content-Length	string	否	响应消息体的字节长度。
Connection	string	否	指明与服务器的连接是长连接还是短连接。
Date	string	否	OBS系统响应的时间。
ETag	string	否	对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。
x-obs-id-2	string	否	帮助定位问题的特殊符号。
x-obs-request-id	string	否	由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。

名称	类型	必选	描述
BucketLoggingStatus	SetBucketMirrorBackToSourceRequestBody object	否

200 BucketLoggingStatus

名称	类型	必选	描述
rules	Array of rules objects	是	策略规则数组。说明: 同一个桶下的不同策略前缀不能重复和起始包含,委托建议使用同一个。

200 BucketLoggingStatus.rules

名称	类型	必选	描述
id	string	是	规则ID。当前桶上配置的镜像回源规则的唯一标识。取值范围:[1, 256],满足“^[a-zA-Z0-9_-]{1, 256}$”
condition	condition object	是	触发回源功能的条件。
redirect	redirect object	是	回源功能主要参数。

200 BucketLoggingStatus.rules.condition

名称	类型	必选	描述
httpErrorCodeReturnedEquals	string	是	触发回源功能的错误码。当下载请求返回此错误码时,会触发回源功能。
objectKeyPrefixEquals	string	否	触发回源功能的对象名前缀。当触发回源的请求里对象名满足此前缀,才会继续执行回源功能。当前缀配置为空时,默认所有对象都匹配。同一个桶上多条规则的前缀之间不允许重复和起始包含。有效值:长度[0, 1023],值允许为任意字符

200 BucketLoggingStatus.rules.redirect

名称	类型	必选	描述
agency	string	是	委托名。客户通过委托赋予OBS服务查询用户桶内指定对象是否存在以及向用户桶内上传对象的权限。
publicSource	publicSource object	否	公共可访问源端配置。当源端为公共可访问的资源时,必选。
retryConditions	Array of strings	否	回源地址切换的条件。类型:数组取值范围:4XX,5XX以及400~499,500~599等具体错误码说明: 4XX和4开头的具体错误码不能同时配置,5XX和5开头的错误码不能同时配置。最大支持同时配置20个错误码
passQueryString	boolean	是	是否携带请求字符串。如果是true,会将OBS请求中的queryString传递到源站。否则,则不会将queryString传递到源站。该值默认值是false,如果设置为false则会忽略。说明: 如果是true,但query里有签名信息,则将签名信息去掉,剩余参数再传递。
mirrorFollowRedirect	boolean	是	是否跟随源站3xx重定向请求获取到资源。如果是true,跟随源站3xx重定向请求获取到资源。否则,OBS会透传3XX响应,不获取资源。该值默认值是false,如果设置为false则会忽略。
redirectWithoutReferer	boolean	否	是否将原host作为referer头域携带到重定向的目的地址去。false为需要携带, true为不携带。
mirrorAllowHttpMethod	Array of strings	否	需要透传的http请求的类型,如HEAD,目前只支持HEAD
mirrorHttpHeader	mirrorHttpHeader object	否	HTTP header传递规则。
replaceKeyWith	string	否	添加前后缀。去源端下载对象的时候,如果需要添加前缀或后缀,则修改此项配置为prefix${key}suffix。如果不需要增加前后缀,则配置为${key}。取值范围:prefix${key}suffix。 ${key}为关键字,prefix为要添加的前缀,suffix为要添加的后缀。同时prefix和suffix的总长度[0, 1023]
replaceKeyPrefixWith	string	否	替换前缀objectKeyPrefixEquals的字符串。如果去源端下载对象时,需要替换当前的对象名前缀,则修改此项配置。如果replaceKeyWith和ReplaceKeyPrefixWith同时为空,则ReplaceKeyPrefixWith生效。同时非空为非法请求。类型:字符串取值范围:长度[0, 1023]
vpcEndpointURN	string	否	终端节点服务的URN。取值范围:长度[0, 127]

200 BucketLoggingStatus.rules.redirect.publicSource

名称	类型	必选	描述
sourceEndpoint	sourceEndpoint object	否	公共可访问的源端地址。

200 BucketLoggingStatus.rules.redirect.publicSource.sourceEndpoint

名称	类型	必选	描述
master	Array of strings	否	主源端地址。如果源端为HTTP公共可访问的桶,则此地址为桶域名地址。如果源端为其他云厂商的私有桶,则此地址为区域域名地址。有效取值:单个源站地址格式为https\|http://xxx.yyy.zzz,长度为[10, 255] 说明: 回源时会优先使用主源站地址,如果同时配置多个主地址,会轮询访问所有主地址。如果配置2个及以上主地址,第一次请求主地址失败,并且满足重试条件时,会选用另一个主地址重试一次。至少配置一个主地址。最多同时配置5个主地址。
slave	Array of strings	否	备源端地址。如果源端为HTTP公共可访问的桶,则此地址为桶域名地址。如果源端为其他云厂商的私有桶,则此地址为区域域名地址。有效取值:单个源站地址格式为https\|http://xxx.yyy.zzz,长度为[10, 255] 说明: 主地址回源失败时,会选用一个备地址进行重试。最多同时配置5个备地址。

名称

类型

必选

描述

master

Array of strings

否

主源端地址。如果源端为HTTP公共可访问的桶,则此地址为桶域名地址。如果源端为其他云厂商的私有桶,则此地址为区域域名地址。

有效取值:单个源站地址格式为https|http://xxx.yyy.zzz,长度为[10, 255]

说明: 回源时会优先使用主源站地址,如果同时配置多个主地址,会轮询访问所有主地址。如果配置2个及以上主地址,第一次请求主地址失败,并且满足重试条件时,会选用另一个主地址重试一次。至少配置一个主地址。最多同时配置5个主地址。

slave

Array of strings

否

备源端地址。如果源端为HTTP公共可访问的桶,则此地址为桶域名地址。如果源端为其他云厂商的私有桶,则此地址为区域域名地址。

有效取值:单个源站地址格式为https|http://xxx.yyy.zzz,长度为[10, 255]

说明: 主地址回源失败时,会选用一个备地址进行重试。最多同时配置5个备地址。

200 BucketLoggingStatus.rules.redirect.mirrorHttpHeader

名称	类型	必选	描述
passAll	boolean	否	是否透传全部HTTP header到源端。以下HTTP header类型不支持透传: 1.以下前缀开头的header: x-obs- x-amz- 2.所有标准HTTP header,例如: Content-Length Authorization Date passAll与pass互斥。
pass	Array of strings	否	指定透传的HTTP header列表。取值范围:最大10个,每个长度[1, 63],key只支持字母(大小写)、数字、中划线、下划线
remove	Array of strings	否	不允许透传的HTTP header列表。 remove优先级高于pass和passAll。取值范围:最大10个,每个长度[1, 63],key只支持字母(大小写)、数字、中划线、下划线
set	Array of set objects	否	设置透传的HTTP header值列表。 set优先级高于remove,pass和passAll。如果自定义头域中包含了Referer头域,必须将redirectWithoutReferer设置为true,不然会被覆盖取值范围:最大10个

200 BucketLoggingStatus.rules.redirect.mirrorHttpHeader.set

名称	类型	必选	描述
key	string	否	设置需要透传HTTP header的关键字。多条key之间不允许重复。取值范围:长度[1, 63],只支持字母(大小写)、数字、中划线、下划线
value	string	否	设置需要透传HTTP header的值。取值范围:长度[0, 2048]

名称

类型

必选

描述

key

string

否

设置需要透传HTTP header的关键字。

多条key之间不允许重复。取值范围:长度[1, 63],只支持字母(大小写)、数字、中划线、下划线

value

string

否

设置需要透传HTTP header的值。

取值范围:长度[0, 2048]

返回码: 400

请求失败响应消息。

名称	类型	必选	描述
Code	string	否	错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2。
Message	string	否	错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2。
RequestId	string	否	本次错误请求的请求ID,用于错误定位。
HostId	string	否	返回该消息的服务端ID。
Resource	string	否	该错误相关的桶或对象资源。

请求示例

示例 1

"/?mirrorBackToSource"

"GET /?mirrorBackToSource HTTP/1.1\nHost: bucketname.obs.cn-north-4.myhuaweicloud.com \nAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo=\nDate: Tue, 21 Jul 2020 22:28:46 GMT\n"

返回示例

返回码：200

请求成功响应消息。

示例 1

HTTP/1.1 200 OK Server: OBS Date: Tue, 07 Jul 2020 07:28:46 GMT Content-Type: application/json Content-Length: 1063 { "rules": [{ "id": "abc123", "condition": { "httpErrorCodeReturnedEquals": 404, "objectKeyPrefixEquals": "video/" }, "redirect": { "agency": "agency", "publicSource": { "sourceEndpoint": { "master":["http://bucket1.xxx.yyy.com", "https://bucket2.xxx.yyy.com"], "slave": ["http://bucket3.xxx.yyy.com", "https://bucket4.xxx.yyy.com"] } }, "retryConditions": ["4XX", "5XX"], "passQueryString": true, "mirrorFollowRedirect": true, "redirectWithoutReferer": true, "mirrorHttpHeader": { "passAll": false, "pass": ["content-encoding"], "remove": ["content-type"], "set": [{ "key": "helloworld", "value": "2222" }] }, "replaceKeyWith": "prefix${key}suffix", "replaceKeyPrefixWith": "picture/", "vpcEndpointURN": "001" } }] }

错误码

请参考错误码说明。