详情页标题前

腾讯云对象存储PUT Bucket Origin

详情页1

功能描述

PUT Bucket Origin 接口用于设置存储桶的回源。

请求

请求示例

PUT /?origin HTTP 1.1Host:.cos..myqcloud.comDate: GMT DateAuthorization: Auth String

说明Host: .cos..myqcloud.com,其中 为带 APPID 后缀的存储桶名字,例如 examplebucket-1250000000,可参阅 存储桶概览 > 基本信息存储桶概述 > 存储桶命名规范 文档; 为 COS 的可用地域,可参阅 地域和访问域名 文档。Authorization: Auth String(详情请参见 请求签名 文档)。该请求需结合请求体一起使用。

请求参数

此接口无请求参数。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

请求的请求体为回源规则。

            Integer        Redirect|Proxy|Mirror                                404                                        HTTP|HTTPS|FOLLOW                        true|false                        true|false                                                        true|false                                                                    
x-cos|oss|amz-ContentType|CacheControl|ContentDisposition|ContentEncoding|HttpExpiresDate|UserMetaData string
x-cos|oss|amz-ContentType|CacheControl|ContentDisposition|ContentEncoding|HttpExpiresDate|UserMetaData
String
true|false 301|302|307 404 403 bucketname-appid.cos.region.myqcloud.com 4 bucketname2-appid.cos.region.myqcloud.com bucketname3-appid.cos.region.myqcloud.com bucketname4-appid.cos.region.myqcloud.com 2 bucketname5-appid.cos.region.myqcloud.com bucketname6-appid.cos.region.myqcloud.com String

具体的数据内容如下:

节点名称(关键字) 父节点 描述 类型 是否必选
OriginConfiguration Origin 回源配置 Container

Container 节点 OriginConfiguration 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
OriginRule OriginConfiguration 支持多条 OriginRule,通过优先级区分规则执行先后 Container

Container 节点 OriginRule 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
RulePriority OriginConfiguration.OriginRule 通过优先级区分规则执行先后 Integer
OriginType OriginConfiguration.OriginRule 回源类型,支持异步回源(Proxy)、同步回源(Mirror)和重定向回源(Redirect)三种模式。 枚举值:ProxyMirrorRedirect Container
OriginCondition OriginConfiguration.OriginRule 回源配置,配置用户使用的 HTTP 传输协议等信息 Container
OriginParameter OriginConfiguration.OriginRule 回源地址相关信息 Container
OriginInfo OriginConfiguration.OriginRule 源站信息。例如源站域名或者源站 IP 等信息 Container

Container 节点 OriginCondition 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
HTTPStatusCode OriginConfiguration.OriginRule.OriginCondition 触发回源的 HTTP 状态码,Proxy 和 Mirror 模式支持填写404,Redirect 模式支持填写4XX 和5XX String
Prefix OriginConfiguration.OriginRule.OriginCondition 触发回源的文件前缀,默认为空,任意文件均可触发 String

Container 节点 OriginParameter 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
Protocol OriginConfiguration.OriginRule.OriginParameter 回源使用的协议,枚举值为 HTTP(使用 HTTP 协议),HTTPS(使用 HTTPS 协议)、FOLLOW(跟随用户使用的协议),默认值为 FOLLOW。 String
FollowQueryString OriginConfiguration.OriginRule.OriginParameter 回源是否需要透传 HTTP 请求串,枚举值:truefalse,默认为 true Boolean
HttpHeader OriginConfiguration.OriginRule.OriginParameter 是否需要设置 Http 头部传输配置。 Container
FollowRedirection OriginConfiguration.OriginRule.OriginParameter 源站 3XX 响应策略,枚举值 truefalse,选择 true 时跟随源站 3xx 重定向请求获取到资源,并将资源保存到 COS 上;选择 false 时透传 3XX 响应,不获取资源),默认为 true Boolean
HttpRedirectCode OriginConfiguration.OriginRule.OriginParameter 仅支持 RedirectProxy 模式,设置重定向返回码参数,枚举值 301302307,默认为 302 String

Container 节点 HttpHeader 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
FollowAllHeaders OriginConfiguration.OriginRule.OriginParameter.HttpHeader 是否传输全部的请求头部,枚举值:truefalse,默认为 false Boolean
NewHttpHeaders OriginConfiguration.OriginRule.OriginParameter.HttpHeader 设置回源新增指定头部,最多10个。 Container
FollowHttpHeaders OriginConfiguration.OriginRule.OriginParameter.HttpHeader 设置回源透传原始请求的指定头部。 Container
ForbidFollowHeaders OriginConfiguration.OriginRule.OriginParameter.HttpHeader 设置回源不透传的原始请求的指定头部。 Container

Container 节点 NewHttpHeaders、FollowHttpHeaders、ForbidFollowHeaders 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
Header OriginConfiguration.OriginRule.OriginParameter.HttpHeader.NewHttpHeader 回源到源站时添加或者指定传递的自定义头部,默认为空。 Container

Container 节点 Header 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
Key OriginConfiguration.OriginRule.OriginParameter.HttpHeader.NewHttpHeader.UserMetaData 用户设置的头部名称,默认为空。形式如 x-A-B,A 支持填入 cosossamz,B 支持填入 ContentTypeCacheControlContentDispositionContentEncodingHttpExpiresDateUserMetaData String
Value OriginConfiguration.OriginRule.OriginParameter.HttpHeader.NewHttpHeader.UserMetaData 用户设置的头部值,默认为空。 String

Container 节点 OriginInfo 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
HostInfo OriginConfiguration.OriginRule.OriginInfo 源站信息。Mirror 模式支持设置多个源站,按比例回源,分担单个源站的回源流量,最多支持填入10条回源地址,比例按权重分配;Proxy 和 Redirect 模式仅支持一个源站。 Container
FileInfo OriginConfiguration.OriginRule.OriginInfo 回源文件信息。 Container

Container 节点 HostInfo 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
HostName OriginConfiguration.OriginRule.OriginInfo.HostInfo 源站域名或者源站 IP。 String
Weight OriginConfiguration.OriginRule.OriginInfo.HostInfo 源站权重,Mirror 模式下配置了多个源站时,会根据权重按比例回源。 Integer
StandbyHostName_N OriginConfiguration.OriginRule.OriginInfo.HostInfo 备份回源地址,最多支持填入10条备份回源地址,节点命名依次按照1-10编号,例如 StandbyHostName_1StandbyHostName_2……StandbyHostName_10 String

Container 节点 FileInfo 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
PrefixConfiguration OriginConfiguration.OriginRule.OriginInfo.FileInfo 回源文件的前缀设置。 Container
SuffixConfiguration OriginConfiguration.OriginRule.OriginInfo.FileInfo 回源文件的后缀设置。 Container
FixedFileConfiguration OriginConfiguration.OriginRule.OriginInfo.FileInfo 回源到固定的文件。 Container

Container 节点 FixedFileConfiguration 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
FixedFilePath OriginConfiguration.OriginRule.OriginInfo.FileInfo.FixedFileConfiguration 回源的固定文件路径。 String

Container 节点 PrefixConfiguration 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
Prefix OriginConfiguration.OriginRule.OriginInfo.FileInfo. PrefixConfiguration 回源文件的新增文件前缀,默认为空。 String

Container 节点 SuffixConfiguration 的内容:

节点名称(关键字) 父节点 描述 类型 是否必选
Suffix OriginConfiguration.OriginRule.OriginInfo.FileInfo. SuffixConfiguration 回源文件的新增文件后缀,默认为空。 String

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

此接口响应体为空。

错误码

此接口遵循统一的错误响应和错误码,详情请参见 错误码 文档。

实际案例

案例1案例2案例3案例4普通 Mirror 模式

请求

PUT /?origin= HTTP/1.1Host: examplebucket-1250000000.cos.ap-shanghai.myqcloud.comAuthorization: q-sign-algorithm=sha1&q-ak=AKIDWtTCBYjM5OwLB9CAwA1Qb2ThTSUj****&q-sign-time=1484639384;32557535384&q-key-time=1484639384;32557535384&q-header-list=host&q-url-param-list=&q-signature=5c07b7c67d56497d9aacb1adc19963135b7d****Content-Length: 347Date: Sun, 28 Apr 2019 12:02:24 GMT
1 Mirror 404 HTTP true false
x-cos exampleHeader
exampleHeaderKey
true 302 examplebucket-1250000000.cos.ap-shanghai.myqcloud.com

响应

HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 0Date: Sun, 28 Apr 2019 12:02:45 GMTServer: tencent-cosx-cos-request-id: NWNjNTk2NTFfMmM4OGY3MGFfNadfadsfY2****

带权重的 Mirror 模式
在如下示例中,回源会透传除 x-cos-example-header 之外原始请求的所有头部;规则指定了两个回源源站,源站1
bucketname1-appid.cos.region.myqcloud.com 和源站2 bucketname2-appid.cos.region.myqcloud.com,权重分别为8和2,80%的回源请求会访问源站1,20%的回源请求会访问源站2。

请求

PUT /?origin= HTTP/1.1Host: examplebucket-1250000000.cos.ap-shanghai.myqcloud.comAuthorization:AuthstringContent-Length:Content-LengthDATE:Sun, 28 Apr 2019 12:02:24 GMT
1 Mirror 404 HTTPS true true
x-cos-example-header
bucketname1-appid.cos.region.myqcloud.com 8 bucketname2-appid.cos.region.myqcloud.com 2

响应

HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 0Date: Sun, 28 Apr 2019 12:02:25 GMTServer: tencent-cosx-cos-request-id: NWNjNTk2NTFfMmM4OGY3MGFfNTI1****

Proxy 模式

请求

PUT /?origin= HTTP/1.1Host: examplebucket-1250000000.cos.ap-shanghai.myqcloud.comAuthorization:AuthstringContent-Length: 347DATE:Sun, 28 Apr 2019 12:02:24 GMT
1 Proxy 404 
FOLLOW true true
x-cos-ContentType csv
Content-Type
true 
examplebucket-1250000000.cos.ap-shanghai.myqcloud.com

响应

HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 0Date: Sun, 28 Apr 2019 12:02:45 GMTServer: tencent-cosx-cos-request-id: NWNjNTk2NTFfMmM4OGY3MGFfNadfadsfY****

Redirect 模式

请求

PUT /?origin= HTTP/1.1Host: examplebucket-1250000000.cos.ap-shanghai.myqcloud.comAuthorization:AuthstringContent-Length: 347DATE:Sun, 28 Apr 2019 12:02:24 GMT
1 Redirect 403 301 examplebucket-1250000000.cos.ap-shanghai.myqcloud.com

响应

HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 0Date: Sun, 28 Apr 2019 12:02:25 GMTServer: tencent-cosx-cos-request-id: NWNjNTk2NTFfMmM4OGY3MGFfNTI1****



对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠

转转请注明出处:https://www.yunxiaoer.com/144992.html

(0)
上一篇 2023年12月9日
下一篇 2023年12月9日
详情页2

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买,续费优惠,保证底价,买贵退差。