接口功能介绍
当云硬盘空间不足时，您可以扩大云硬盘的容量，也就是云硬盘扩容。此接口也支持随云主机订购的系统盘及数据盘的扩容。
当您扩容成功后，需要将扩容部分的容量划分至原有分区内，或者对扩容部分的云硬盘分配新的分区。详见：
云硬盘扩容概述
接口约束
1、扩容之后的云硬盘没有超过配额。您可以前往“控制台-服务配额”查看云硬盘的容量配额。
2、若要扩容云硬盘，需要保证云硬盘所在的资源池余量未告罄。
3、仅“未挂载”或“已挂载”状态的云硬盘支持扩容操作。
4、云硬盘处于“已挂载”状态，且是非共享盘，则其挂载的云主机状态必须为“运行中”或“关机”才支持扩容。
5、云硬盘处于“已挂载”状态，且是共享盘，则其挂载的所有云主机状态必须都为“运行中”或“关机”才支持扩容。
6、按需云主机支持“节省关机模式”，此模式下关闭云主机，云主机也处于“关机”状态，同样支持扩容云硬盘。
7、扩容时请谨慎操作，误操作可能会导致数据丢失或者异常，建议扩容前对数据进行备份，推荐使用云硬盘备份。
8、云硬盘扩容功能支持扩大云硬盘容量，不支持缩小云硬盘容量。
接口是否审批
否
URI
POST JSON /v4/ebs/resize-ebs
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| diskSize | 是 | Integer | 变配后的云硬盘大小，数据盘的取值范围为： ●XSSD-0：10GB-65536GB ●XSSD-0：40GB-65536GB | 20 | |
| diskID | 是 | String | 待扩容的云硬盘ID。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1bxx | |
| regionID | 否 | String | 如本地语境支持保存regionID，那么建议传递。 | 81f7728662dd11ec810800155d307d5b | |
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | resize0211v3 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败)。 | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述。 | region info empty | |
| description | String | 成功或失败时的描述，一般为中文描述。 | 资源池信息为空。 | |
| returnObj | Object | 返回结构体。 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码，请参考错误码。 | ebs.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码，请参考错误码。 | Ebs.RegionInfo.Empty | |
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 其他订单侧(bss)的错误，以Ebs.Order.ProcFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息。 | errorDetail |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用masterOrderID进一步确认订单状态及资源状态。 | beacf51a20dd4889bfc99877d89e03e2 | |
| masterOrderNO | String | 订单号。 | 20220812171600203284 | |
| masterResourceID | String | 主资源ID。 | a51826820e0b449c8fea9285ee7f4224 | |
| masterResourceStatus | String | 主资源状态。只有主订单资源会返回。 | started |
表 errorDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bssErrCode | String | bss错误明细码，包含于bss格式化JSON错误信息中。 | bss.xxx.xxx | |
| bssErrMsg | String | bss错误信息，包含于bss格式化JSON错误信息中。 | 账号验证失败。 | |
| bssOrigErr | String | 无法明确解码bss错误信息时，原样透出的bss错误信息。 | get account info failed | |
| bssErrPrefixHint | String | bss格式化JSON错误信息的前置提示信息。 | get account info failed |
请求示例
请求头header
{
}请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"diskID":"0ae97ef5-6ee2-44af-9d05-1a509b0a1be6",
"diskSize":20,
"clientToken":"resize0211v3"
}响应示例
{
"returnObj": {
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterOrderNO": "20220812171600203284"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}状态码
请参考状态码
错误码
请参考错误码
