接口功能介绍
支持云主机挂载云硬盘。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 云主机挂载云硬盘的数目没有超过配额
2. 云硬盘非共享盘只能挂1个云主机,共享盘最多挂16个云主机
3. 只有未挂载状态的云硬盘支持挂载操作,其他状态不支持挂载
URI
POST /v4/ecs/volume/attach
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskID | 是 | String | 磁盘ID,您可以查看产品定义-云硬盘来了解云硬盘 获取: 查 云硬盘列表查询 创 创建云硬盘 |
6f8928c7-f961-4ece-b0ee-9f8d6b4663b5 | |
regionID | 否 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID。多可用区资源池下,云硬盘和云主机必须在同个az才能支持挂载。您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
c54322f1-735d-409d-2a7c-76d611492469 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码. 请参考通用结果码 | Ebs.RegionInfo.AccessFailed | |
message | String | 失败时的错误描述,一般为英文描述 | Param is null | |
description | String | 失败时的错误描述,一般为中文描述 | 请求为空 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
diskJobID | String | 异步任务ID,可通过公共接口通用任务状态查询该jobID的异步任务最终执行结果 | 5fb1e26-b83d-4d0b-b31f-2e64d2c9dd99 | |
diskRequestID | String | 异步任务ID,可通过公共接口通用任务状态查询该jobID的异步任务最终执行结果 | 5fb1e26-b83d-4d0b-b31f-2e64d2c9dd99 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:在华东1资源池将指定磁盘挂载到一台云主机
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"diskID": "6f8928c7-f961-4ece-b0ee-9f8d6b4663b5",
"instanceID": "c54322f1-735d-409d-2a7c-76d611492469"
}
响应示例
{
"returnObj": {
"diskJobID": "55fb1e26-b83d-4d0b-b31f-2e64d2c9dd99",
"diskRequestID": "55fb1e26-b83d-4d0b-b31f-2e64d2c9dd99"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码