云硬盘开通

2023-05-15 14:30| 来源: 网络整理| 查看: 265

接口介绍

支持按需/包年包月创建云硬盘。

接口约束

1、用户云硬盘配额未满；

2、用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单；

URI

POST JSON /v4/ebs/new-ebs

请求参数请求体body参数参数是否必填参数类型说明示例下级对象 clientToken 否 String 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。参考请求示例 regionID 是 String 资源池ID, 例:100054c0416811e9a6690242ac110002 参考请求示例 multiAttach 否 Boolean 是否多云主机挂载，默认false 参考请求示例 isEncrypt 否 Boolean 是否加密盘，默认false 参考请求示例 kmsUUID 否 String 如果是加密盘，需要提供kms的uuid 参考请求示例 projectID 否 String 企业项目ID,默认为”0” 参考请求示例 diskMode 是 String 磁盘模式，VBD/ISCSI/FCSAN 参考请求示例 diskType 是 String 磁盘类型，SATA/SAS/SSD-genric/SSD 参考请求示例 diskName 是 String 磁盘命名，单账户单资源池下，命名需唯一参考请求示例 diskSize 是 Integer 磁盘大小，单位GB 参考请求示例 onDemand 否 Boolean 是否按需下单。默认为true 参考请求示例 cycleType 否 String 包周期类型，year/month。onDemand为false时，必须指定。参考请求示例 cycleCount 否 Integer 包周期数。onDemand为false时必须指定。周期最大长度不能超过5年参考请求示例 azName 否 String 多可用区资源池下，必须指定可用区参考请求示例响应参数参数是否必填参数类型说明示例下级对象 statusCode Integer 返回状态码(800为成功，900为处理中/失败，详见errorCode) message String 失败时的错误描述，一般为英文描述 description String 失败时的错误描述，一般为中文描述 returnObj Object returnObj 参考表returnObj errorCode String 业务细分码，为product.module.code三段式码.参考通用结果码 errorDetail Object 错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。其他订单侧(bss)的错误，以ebs.order.procFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息

表 returnObj

参数是否必填参数类型说明示例下级对象 masterOrderID String 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。 masterOrderNO String 订单号 masterResourceID String 主资源ID。云硬盘场景下，无需关心。 masterResourceStatus String 主资源状态。只有主订单资源会返回 regionID String 资源所属资源池ID resources Object 资源明细列表,参考表resources 参考表resources

表 resources

参数是否必填参数类型说明示例下级对象 diskID String 资源底层ID，即磁盘ID orderID String 无需关心 startTime Integer 启动时刻，epoch时戳，毫秒精度 createTime Integer 创建时刻，epoch时戳，毫秒精度 updateTime Integer 更新时刻，epoch时戳，毫秒精度 status Integer 资源状态，无需关心。参考masterResourceStatus isMaster Boolean 是否是主资源项 itemValue Integer 资源规格，磁盘资源为磁盘大小GB resourceType String 资源类型 resourceConfig Object of String 可忽略 diskName String 云硬盘名称

表 errorCode

参数是否必填参数类型说明示例下级对象 ebs.order.accessFailed String 订单系统访问失败，可使用clientToken重试订单 ebs.order.inProgress String 订单处理中，可使用订单ID查询确认或使用原clientToken重试下单 ebs.order.procFailed String 订单处理失败。无需重试。通过返回description确认失败原因。 ebs.order.orderChanged String 订单状态变更，比如发生了撤单，取消等。 ebs.order.accepted String 订单已成功，资源创建中。可以使用clientToken或者返回的masterResourceID重试订单，以确认订单状态。此时不返回masterResourceID及resources ebs.order.userFrozen String 用户受限，可能是被冻结的账户，或者余额不足 ebs.order.userQuotaLimited String 用户配额不足 ebs.order.regionServiceAccessFailed String 访问资源池失败 ebs.order.unexpectedResponse String 订单侧响应不符合预期 ebs.order.resourceDeployFailed String 资源施工失败其他参考通用结果码

表 errorDetail

参数是否必填参数类型说明示例下级对象 bssErrCode String bss错误明细码，包含于bss格式化JSON错误信息中 bssErrMsg String bss错误信息，包含于bss格式化JSON错误信息中 bssOrigErr String 无法明确解码bss错误信息时，原样透出的bss错误信息 bssErrPrefixHint String bss格式化JSON错误信息的前置提示信息请求示例请求头header { } 请求体body { "clientToken": "20230211ebsspec7", "diskName":"ebs-newspec-test0211v7", "diskMode":"VBD", "diskType":"SATA", "diskSize":10, "regionID":"81f7728662dd11ec810800155d307d5b", "azName":"az2", "onDemand": false, "cycleType":"month", "cycleCount":1 } 响应示例 { 订单处理中： { "httpstatus": 200, "httpresult": { "description": "订单处理中，可使用订单ID查询或使用原clientToken重试下单", "returnObj": { "masterOrderNO": "20230211101627206684", "regionID": "81f7728662dd11ec810800155d307d5b", "masterOrderID": "16702126a9b211ed94aa0242ac110005" }, "errorCode": "ebs.order.inProgress", "message": "order in progress", "statusCode": 900 } } 用重复的clientToken和相同参数继续执行，创建成功后会返回： "returnObj": { "masterResourceStatus": "started", "regionID": "81f7728662dd11ec810800155d307d5b", "masterOrderID": "16702126a9b211ed94aa0242ac110005", "masterResourceID": "a51826820e0b449c8fea9285ee7f4224", "masterOrderNO": null, "resources": [ { "orderID": "7ce378d78ff84b47b1eef7ff392ff021", "status": 2, "isMaster": true, "diskName": "ebs-newspec-test0211v7", "resourceType": "EBS", "masterOrderID": "16702126a9b211ed94aa0242ac110005", "updateTime": 1676081822000, "masterResourceID": "a51826820e0b449c8fea9285ee7f4224", "itemValue": 10, "startTime": 1676081818000, "createTime": 1676081789000, "diskID": "0ae97ef5-6ee2-44af-9d05-1a509b0a1be6" } ] }, "message": "SUCCESS", "description": "成功", "statusCode": 800 } 状态码状态码描述 800 表示请求成功。错误码

请参考云硬盘开通-表 errorCode。

【本文地址】

公司简介

联系我们

今日新闻

推荐新闻

专题文章