PutBucketWebsite_对象存储_API文档-阿里云OpenAPI开发者门户

接口说明

功能支持：此接口主要用于设置默认主页、默认 404 页和 RoutingRule。RoutingRule 用来指定 3xx 跳转规则以及镜像回源规则。其中镜像回源支持公共云和金融云。
使用自有域名访问静态网站：如果要使用自有域名来访问基于 Bucket 的静态网站，您可以通过域名 CNAME 来实现。具体操作，请参见绑定自定义域名。
索引页面和错误页面：将一个 Bucket 设置为静态网站托管模式时，如果指定了索引页面或错误页面，则指定的索引页面和错误页面为该 Bucket 内的某个 Object。
对静态网站根域名的匿名访问：将一个 Bucket 设置为静态网站托管模式后，对静态网站根域名的匿名访问，OSS 将返回索引页面。对静态网站根域名的签名访问，OSS 将返回 GetBucket(ListObjects)的结果。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

oss:PutBucketWebsite	Update	Bucket acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}	acs:UserAgent acs:AccessId oss:BucketTag oss:TLSVersion	无

请求语法

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

PutBucketWebsite_对象存储_API文档

接口说明

流控信息

授权信息

请求语法

请求参数

变更历史

相关示例