找不到 API ? 点击 反馈吧
- 服务
- 地域
- 存储空间
- 基础操作
- 接入点
- 合规保留策略
- 权限控制
- 生命周期
- 传输加速
- 版本控制
- 授权策略
- 数据复制
- 清单
- 日志管理
- 静态网站
- 防盗链
- 标签
- 存储冗余转换
- 加密
- 请求者付费
- 跨资源共享
- 访问跟踪
- 数据索引
- 高防
- 资源组
- 自定义域名
- 图片样式
- 安全传输层协议(TLS)
- 对象FC接入点
- 阻止公共访问
- 归档直读
- 文件
- 直播推流
- 其他
- 其它
PutBucketWebsite
将存储空间(Bucket)设置为静态网站托管模式并设置跳转规则(RoutingRule)
服务地址:
华东1 金融云
参数配置
高级配置
输入参数
只看必填
注意事项
bucketBucket名称
body保存静态网站配置的容器
WebsiteConfiguration根节点
IndexDocument默认主页的容器
Suffix默认主页
SupportSubDir访问子目录时
请选择布尔值
Type设置默认主页后
ErrorDocument404页面的容器
Key错误页面
HttpStatus返回错误页面时的HTTP状态码
RoutingRulesRoutingRule的容器
RoutingRule指定跳转规则或者镜像回源规则
0指定跳转规则或者镜像回源规则
RuleNumber匹配和执行RoutingRule的序号
Condition匹配的条件
KeyPrefixEquals只有匹配此前缀的Object才能匹配此规则
KeySuffixEquals只有匹配此后缀的Object才能匹配此规则
HttpErrorCodeReturnedEquals访问指定Object时
IncludeHeader只有请求中包含了指定Header且值为...
0
Key只有请求中包含了此Header且值满足条件
Equals只有请求中包含了Key指定的Heade...
StartsWith只有请求中包含了Key指定的Heade...
EndsWith只有请求中包含了Key指定的Heade...
Redirect指定匹配此规则后执行的动作
RedirectType指定跳转的类型
PassQueryString执行跳转或者镜像回源规则时
请选择布尔值
MirrorURL镜像回源的源站地址
MirrorSNI是否透传SNI
请选择布尔值
MirrorPassQueryString与PassQueryString作用相同
请选择布尔值
MirrorFollowRedirect如果镜像回源获取的结果为3xx
请选择布尔值
MirrorCheckMd5是否检查回源body的MD5
请选择布尔值
MirrorHeaders指定镜像回源时携带的Header
Protocol跳转时的协议
HostName跳转时的域名
ReplaceKeyPrefixWithRedirect时Object名称的前...
EnableReplacePrefix如果设置此字段为true
请选择布尔值
ReplaceKeyWithRedirect时Object名称将替...
HttpRedirectCode跳转时返回的状态码
MirrorPassOriginalSlashes是否透传/到源站
请选择布尔值
MirrorURLSlave镜像回源主备回源备站URL
MirrorURLProbe镜像回源主备回源切换判定URL
MirrorSaveOssMeta镜像回源回源OSS是否自动保存用户元数据
请选择布尔值
MirrorProxyPass镜像回源是否不保存数据
请选择布尔值
MirrorAllowGetImageInfo镜像回源允许获取Image信息
请选择布尔值
MirrorAllowVideoSnapshot镜像回源允许支持视频截帧
请选择布尔值
MirrorIsExpressTunnel是否是镜像回源高速通道
请选择布尔值
MirrorDstRegion镜像回源高速通道VpcRegion
MirrorDstVpcId镜像回源高速通道VpcId
MirrorDstSlaveVpcId镜像回源高速通道备站VpcId
MirrorUserLastModified镜像回源保存文件是否使用源站LastM...
请选择布尔值
MirrorSwitchAllErrors用于主备切换的状态判断
请选择布尔值
MirrorTunnelId镜像回源专线回源TunnelId
MirrorUsingRole镜像回源是否使用角色
请选择布尔值
MirrorRole镜像回源回源时使用的角色
MirrorAllowHeadObject镜像回源是否允许HeadObject
请选择布尔值
TransparentMirrorResponseCodes指定当源站返回哪些状态码时需要透传该状...
MirrorAsyncStatus镜像回源触发异步拉取模式的状态码
MirrorTaggings镜像回源保存文件时根据参数保存标签
Taggings镜像回源保存标签规则列表
MirrorReturnHeaders保存镜像回源返回响应头规则的容器
ReturnHeader镜像回源返回响应头规则列表
MirrorAuth镜像回源源站认证信息
AuthType镜像回源源站认证类型
Region镜像回源源站签名Region
AccessKeyId镜像回源源站回源AK
AccessKeySecret镜像回源源站回源SK
MirrorMultiAlternates镜像回源多源站配置列表
MirrorMultiAlternate镜像回源多源站配置
0
MirrorMultiAlternateNumber镜像回源多源站序号
MirrorMultiAlternateURL镜像回源多源站URL
MirrorMultiAlternateVpcId镜像回源多源站VpcId
MirrorMultiAlternateDstRegion镜像回源多源站Region
LuaConfig需要执行的Lua脚本配置
ScriptLua脚本名称
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
-
功能支持:此接口主要用于设置默认主页、默认 404 页和 RoutingRule。RoutingRule 用来指定 3xx 跳转规则以及镜像回源规则。其中镜像回源支持公共云和金融云。
-
使用自有域名访问静态网站:如果要使用自有域名来访问基于 Bucket 的静态网站,您可以通过域名 CNAME 来实现。具体操作,请参见绑定自定义域名。
-
索引页面和错误页面:将一个 Bucket 设置为静态网站托管模式时,如果指定了索引页面或错误页面,则指定的索引页面和错误页面为该 Bucket 内的某个 Object。
-
对静态网站根域名的匿名访问:将一个 Bucket 设置为静态网站托管模式后,对静态网站根域名的匿名访问,OSS 将返回索引页面。对静态网站根域名的签名访问,OSS 将返回 GetBucket(ListObjects)的结果。
请求语法
PUT /?website HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
<?xml version="1.0" encoding="UTF-8"?>
<WebsiteConfiguration>
<IndexDocument>
<Suffix>string</Suffix>
<SupportSubDir>boolean</SupportSubDir>
<Type>integer</Type>
</IndexDocument>
<ErrorDocument>
<Key>string</Key>
<HttpStatus>integer</HttpStatus>
</ErrorDocument>
<RoutingRules>
<RoutingRule>
<RuleNumber>integer</RuleNumber>
<Condition>
<KeyPrefixEquals>string</KeyPrefixEquals>
<KeySuffixEquals>string</KeySuffixEquals>
<HttpErrorCodeReturnedEquals>integer</HttpErrorCodeReturnedEquals>
<IncludeHeader>
<Key>string</Key>
<Equals>string</Equals>
<StartsWith>string</StartsWith>
<EndsWith>string</EndsWith>
</IncludeHeader>
</Condition>
<Redirect>
<RedirectType>string</RedirectType>
<PassQueryString>boolean</PassQueryString>
<MirrorURL>string</MirrorURL>
<MirrorSNI>boolean</MirrorSNI>
<MirrorPassQueryString>boolean</MirrorPassQueryString>
<MirrorFollowRedirect>boolean</MirrorFollowRedirect>
<MirrorCheckMd5>boolean</MirrorCheckMd5>
<MirrorHeaders>
<PassAll>boolean</PassAll>
<Pass>string</Pass>
<Remove>string</Remove>
<Set>
<Key>string</Key>
<Value>string</Value>
</Set>
</MirrorHeaders>
<Protocol>string</Protocol>
<HostName>string</HostName>
<ReplaceKeyPrefixWith>string</ReplaceKeyPrefixWith>
<EnableReplacePrefix>boolean</EnableReplacePrefix>
<ReplaceKeyWith>string</ReplaceKeyWith>
<HttpRedirectCode>integer</HttpRedirectCode>
<MirrorPassOriginalSlashes>boolean</MirrorPassOriginalSlashes>
<MirrorURLSlave>string</MirrorURLSlave>
<MirrorURLProbe>string</MirrorURLProbe>
<MirrorSaveOssMeta>boolean</MirrorSaveOssMeta>
<MirrorProxyPass>boolean</MirrorProxyPass>
<MirrorAllowGetImageInfo>boolean</MirrorAllowGetImageInfo>
<MirrorAllowVideoSnapshot>boolean</MirrorAllowVideoSnapshot>
<MirrorIsExpressTunnel>boolean</MirrorIsExpressTunnel>
<MirrorDstRegion>string</MirrorDstRegion>
<MirrorDstVpcId>string</MirrorDstVpcId>
<MirrorDstSlaveVpcId>string</MirrorDstSlaveVpcId>
<MirrorUserLastModified>boolean</MirrorUserLastModified>
<MirrorSwitchAllErrors>boolean</MirrorSwitchAllErrors>
<MirrorTunnelId>string</MirrorTunnelId>
<MirrorUsingRole>boolean</MirrorUsingRole>
<MirrorRole>string</MirrorRole>
<MirrorAllowHeadObject>boolean</MirrorAllowHeadObject>
<TransparentMirrorResponseCodes>string</TransparentMirrorResponseCodes>
<MirrorAsyncStatus>integer</MirrorAsyncStatus>
<MirrorTaggings>
<Taggings>
<Key>string</Key>
<Value>string</Value>
</Taggings>
</MirrorTaggings>
<MirrorReturnHeaders>
<ReturnHeader>
<Key>string</Key>
<Value>string</Value>
</ReturnHeader>
</MirrorReturnHeaders>
<MirrorAuth>
<AuthType>string</AuthType>
<Region>string</Region>
<AccessKeyId>string</AccessKeyId>
<AccessKeySecret>string</AccessKeySecret>
</MirrorAuth>
<MirrorMultiAlternates>
<MirrorMultiAlternate>
<MirrorMultiAlternateNumber>integer</MirrorMultiAlternateNumber>
<MirrorMultiAlternateURL>string</MirrorMultiAlternateURL>
<MirrorMultiAlternateVpcId>string</MirrorMultiAlternateVpcId>
<MirrorMultiAlternateDstRegion>string</MirrorMultiAlternateDstRegion>
</MirrorMultiAlternate>
</MirrorMultiAlternates>
</Redirect>
<LuaConfig>
<Script>string</Script>
</LuaConfig>
</RoutingRule>
</RoutingRules>
</WebsiteConfiguration>
请求参数
字段名称 | 字段详情 |
---|---|
bucketstring | Bucket 名称。 示例值:examplebucket |
bodyobject | 保存静态网站配置的容器。 |
返回参数
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2024-02-22 | 变更请求参数body | ||
2024-02-21 | 新增请求参数body |