查詢靜態網絡配置
更新時間 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 //zos-global.ctapi.daliqc.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 枚舉值，見錯誤碼總表
