查询静态网络配置
更新时间 2025-06-11 14:55:21
最近更新时间: 2025-06-11 14:55:21
接口介绍
查询与存储桶关联的静态网站配置信息。
接口约束
支持的线上资源池 ：上海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
GET /v4/oss/get-bucket-website
请求参数
请求 Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| description | String | 状态描述，一般为中文 | 成功 |
| returnObj | Object | 响应对象 | 见下级对象 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| redirectAllRequestsTo | Object | 指定所有请求到桶的网站端点的重定向行为 | 见下级对象 |
| indexDocument | Object | 网站索引文档的名称（例如 index.html ） | 见下级对象 |
| errorDocument | Object | 用于 4XX 类错误的网站错误文档的对象键名 | 见下级对象 |
| routingRules | Array of Objects | 定义何时应用重定向和重定向行为的规则 | 见下级对象 |
表 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 类错误时使用的对象键名 | obj1 |
表 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 |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-bucket-website?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0
响应示例
{
"returnObj": {
"indexDocument": {
"suffix": "index.html"
},
"errorDocument": {
"key": "obj1"
},
"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 枚举值，见错误码总表
