设置静态网络托管-对象存储-API参考-API-Bucket进阶操作

接口介绍

将存储桶设置成静态网站托管模式。

接口约束

支持的线上资源池：上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。

URI

POST /v4/oss/put-bucket-website

请求参数

请求体 JSON Body 参数

参数	是否必填	参数类型	说明	示例
bucket	是	String	桶名	bucket1
regionID	是	String	区域 ID	332232eb-63aa-465e-9028-52e5123866f0
websiteConfiguration	是	Object

表 websiteConfiguration

参数	是否必填	参数类型	说明	示例
redirectAllRequestsTo	否	Object	指定所有请求到桶的网站端点的重定向行为。若传入此参数， indexDocument, errorDocument, routingRules 不生效	见下级对象
indexDocument	否	Object	网站索引文档的名称（例如 index.html ）。redirectAllRequestsTo 不存在时必填	见下级对象
errorDocument	否	Object	用于 4XX 类错误的网站错误文档的对象键名。redirectAllRequestsTo 不存在时必填	见下级对象
routingRules	否	Array of Objects	定义何时应用重定向和重定向行为的规则。redirectAllRequestsTo 不存在时必填	见下级对象

表 redirectAllRequestsTo

参数	是否必填	参数类型	说明	示例
hostName	是	String	在重定向请求中使用的主机名	host1
protocol	否	String	值为 http 或 https	https

表 indexDocument

参数	是否必填	参数类型	说明	示例
suffix	是	String	一个后缀，它被附加到网站端点上的一个目录的请求上（例如，如果后缀是index.html，你向samplebucket/images/提出请求，返回的数据将是键名为images/index.html的对象）。后缀不能是空的，也不能包括斜线字符	index.html

表 errorDocument

参数	是否必填	参数类型	说明	示例
key	是	String	发生 4XX 类错误时使用的对象键名	error.html

表 routingRules

参数	是否必填	参数类型	说明	示例
redirect	是	Object	重定向信息。你可以将请求重定向到另一个主机，另一个页面，或用另一个协议。在出现错误的情况下，你可以指定一个不同的错误代码来返回。	见下级对象
condition	否	Object	描述必须满足的条件，以应用指定的重定向。例如，1.如果请求的是/docs文件夹中的页面，则重定向到/documents文件夹。2. 如果请求的结果是HTTP错误4xx，则将请求重定向到另一个你可能处理错误的主机	见下级对象

表 redirect

参数	是否必填	参数类型	说明	示例
hostName	否	String	在重定向请求中使用的主机名	host1
replaceKeyWith	否	String	在重定向请求中使用的特定对象键。例如，重定向请求到error.html 。只有在没有提供ReplaceKeyPrefixWith时才能出现	error.html
protocol	否	String	值为 http 或 https。重定向请求时要使用的协议。默认是原始请求中使用的协议	https
replaceKeyPrefixWith	否	String	在重定向请求中使用的对象关键前缀。例如，要将所有前缀为docs/的页面（docs/文件夹中的对象）的请求重定向到documents/，你可以设置一个条件块，将KeyPrefixEquals设置为docs/，并在Redirect中设置ReplaceKeyPrefixWith为/documents。只有在没有提供ReplaceKeyWith的情况下才能出现	/documents
httpRedirectCode	否	String	响应中要使用的HTTP重定向代码	301

表 condition

参数	是否必填	参数类型	说明	示例
httpErrorCodeReturnedEquals	否	String	应用重定向时的 HTTP 错误代码。如果发生错误，如果错误代码等于此值，则应用指定的重定向。当指定了父元素 Condition 且未指定同级参数 KeyPrefixEquals 时是必需的。如果两者都指定，则两者都必须为真才能应用重定向	404
keyPrefixEquals	否	String	应用重定向时的对象键名称前缀。例如，要重定向对 ExamplePage.html 的请求，键前缀将为 ExamplePage.html 。要重定向所有带有前缀 docs/ 的页面的请求，关键前缀将是 /docs ，它标识 docs/ 文件夹中的所有对象。当指定父元素 Condition 且未指定同级参数 HttpErrorCodeReturnedEquals 时是必需的。如果指定了两个条件，则两个条件都必须为真才能应用重定向	ExamplePage.html

响应参数

参数	参数类型	说明	示例
statusCode	Integer	返回码取值范围：800 成功	800
message	String	状态描述	SUCCESS
description	String	状态描述，一般为中文	成功
errorCode	String	业务细分码（仅失败时具有此参数），为product.module.code三段式码	openapi.userPermission.accessFailed

请求示例

{
    "bucket": "bucket1",
    "regionID": "332232eb-63aa-465e-9028-52e5123866f0",
    "websiteConfiguration": {
        "indexDocument": {
            "suffix": "index.html"
        },
        "errorDocument": {
            "key": "error.html"
        },
        "routingRules": [
            {
                "redirect": {
                    "hostName": "host1",
                    "replaceKeyWith": "error.html",
                    "protocol": "https",
                    "httpRedirectCode": "301"
                },
                "condition": {
                    "httpErrorCodeReturnedEquals": "404",
                    "keyPrefixEquals": "ExamplePage.html"
                }
            }
        ]
    }
}

响应示例

{
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
}

状态码

状态码	描述
800	表示请求成功。
900	表示请求失败。

错误码

errorCode 枚举值，见错误码总表

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

对象存储

对象存储

接口介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

对象存储

对象存储

接口介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码