對象存儲服務開通
更新時間 2025-06-11 14:55:14
最近更新時間: 2025-06-11 14:55:14
分享文章
接口介紹
開通指定資源池節點的對象存儲服務,開通會自動確認天翼云對象存儲系統服務協議。
接口約束
支持的線上資源池:上海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/new
請求參數
請求體 JSON Body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 區域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| clientToken | 否 | String | 客戶端存根,要求單個云平臺賬戶內唯一。請求后 24 小時內,使用相同的clientToken再次請求將忽略regionid,查詢clientToken對應開通單的狀態 | 847b561a-a801-4e26-ae70-e4a1fd58cfd4 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回碼 取值范圍:800 成功,900為處理中或失敗,詳見 errorCode |
800 |
| message | String | 狀態描述 | SUCCESS |
| returnObj | Object | 響應對象 | 見下級對象 |
| description | String | 狀態描述,一般為中文 | 成功 |
| errorCode | String | 業務細分碼(僅處理中/失敗時具有此參數),為product.module.code三段式碼 | openapi.userPermission.accessFailed |
| errorDetail | Object | 錯誤明細。一般情況下,會對訂單側(bss)的對象存儲訂單業務相關的錯誤做明確的錯誤映射和提升,有唯一對應的 errorCode 。 其他訂單側(bss)的錯誤,以 oss.order.procFailed 的 errorCode 統一映射返回,并在 errorDetail 中返回訂單側的詳細錯誤信息 | 見下級對象 |
表 returnObj
| 字段名 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| masterOrderID | String | 訂單ID。調用方在拿到masterOrderID之后,在若干錯誤情況下,可以使用materOrderID進一步確認訂單狀態及資源狀態 | f01190c79f5348159c8d94ed3a816b39 |
| masterOrderNO | String | 訂單號,可為 null | null |
| regionID | String | 資源所屬資源池ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| masterResourceID | String | 主資源ID。對象存儲場景下,無需關心 | 711698765e2b463eb21c41369ca41edd |
| masterResourceStatus | String | 主資源狀態。只有主訂單資源會返回 | started |
| resources | Object | 資源明細列表,參考表resources | 見下級對象 |
表 resources
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| zosID | String | 單項資源的變配、續訂、退訂等需要該資源項的ID | 711698765e2b463eb21c41369ca41edd |
| orderID | String | 內部參數,無需關心 | 922305dd26da47ceadfb06747aa9b420 |
| startTime | Integer | 啟動時刻,epoch時戳,毫秒精度 | 1669884667000 |
| createTime | Integer | 創建時刻,epoch時戳,毫秒精度 | 1669884613000 |
| updateTime | Integer | 更新時刻,epoch時戳,毫秒精度 | 1669884671000 |
| status | Integer | 資源狀態,無需關心。參考 masterResourceStatus | 2 |
| isMaster | Boolean | 是否是主資源項 | true |
| itemValue | Integer | 資源規格,對象存儲場景下,無需關心 | 1 |
| resourceType | String | 資源類型 | ZOS_REG |
| masterResourceID | String | 主資源ID。對象存儲場景下,無需關心 | 711698765e2b463eb21c41369ca41edd |
| masterOrderID | String | 訂單ID。調用方在拿到masterOrderID之后,在若干錯誤情況下,可以使用 materOrderID 進一步確認訂單狀態及資源狀態 | f01190c79f5348159c8d94ed3a816b39 |
表 resourceType
| resourceType | 說明 |
|---|---|
| ZOS_REG | 對象存儲服務開通固定為:ZOS_REG |
表 errorCode
| errorCode | 說明 |
|---|---|
| oss.order.accessFailed | 訂單系統訪問失敗,可使用clientToken重試訂單 |
| oss.order.inProgress | 訂單處理中,可使用訂單ID查詢確認或使用原clientToken重試下單 |
| oss.order.procFailed | 訂單處理失敗。無需重試。通過返回description確認失敗原因。 |
| oss.order.orderChanged | 訂單狀態變更,比如發生了撤單,取消等。 |
| oss.order.accepted | 訂單已成功,資源創建中。 可以使用clientToken重試訂單,以確認訂單狀態。 |
| oss.order.userFrozen | 用戶受限,可能是被凍結的賬戶,或者余額不足 |
| oss.order.userQuotaLimited | 用戶配額不足 |
| oss.order.regionServiceAccessFailed | 訪問資源池失敗 |
| oss.order.unExpectedResponse | 訂單側響應不符合預期 |
| oss.order.resourceDeployFailed | 資源施工失敗 |
表 errorDetail
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| bssErrCode | String | bss錯誤明細碼,包含于bss格式化JSON錯誤信息中 | code_foo |
| bssErrMsg | String | bss錯誤信息,包含于bss格式化JSON錯誤信息中 | error_foo |
| bssOrigErr | String | 無法明確解碼bss錯誤信息時,原樣透出的bss錯誤信息 | unknow_error |
| bssErrPrefixHint | String | bss格式化JSON錯誤信息的前置提示信息 | error_bar |
請求示例
{
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"clientToken": "847b561a-a801-4e26-ae70-e4a1fd58cfd4"
}
響應示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"masterOrderID": "f01190c79f5348159c8d94ed3a816b39",
"masterResourceID": "711698765e2b463eb21c41369ca41edd",
"masterOrderNO": null,
"resources": [
{
"orderID": "922305dd26da47ceadfb06747aa9b420",
"status": 2,
"isMaster": true,
"resourceType": "ZOS_REG",
"zosID": "711698765e2b463eb21c41369ca41edd",
"masterOrderID": "f01190c79f5348159c8d94ed3a816b39",
"updateTime": 1669884671000,
"masterResourceID": "711698765e2b463eb21c41369ca41edd",
"itemValue": 1,
"startTime": 1669884667000,
"createTime": 1669884613000
}
]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示訂單處理中或請求失敗。 |
錯誤碼
errorCode 枚舉值,見錯誤碼總表