接口介绍
开通指定资源池节点的对象存储服务，开通会自动确认天翼云对象存储系统服务协议。
接口约束
支持的线上资源池：上海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 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | 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 | 见下级对象 |
表 masterResourceStatus
| masterResourceStatus | 说明 |
|---|---|
| unknown | 未知 |
| failed | 错误 |
| starting | 正在启用 |
| started | 启用 |
| renewed | 续订 |
| changed | 升级 |
| refunded | 退订 |
| expired | 过期 |
| destroyed | 销毁 |
| onDemandChanged | 转按量 |
| 9 | 后付费降级 |
| autoOnDemandChanged | 已自动转按量 |
| cycleBillChanged | 按量转包周期 |
| deleted | 逻辑删除 |
表 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 枚举值，见错误码总表
