云主机添加共享网卡
接口功能介绍
给云主机添加共享网卡
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
该接口给云主机添加共享网卡后,共享网卡不能通过普通网卡方式进行卸载,只能随着退订云主机时进行删除,请谨慎使用
接口约束
1、确保当前请求资源池下,该云主机、子网存在
2、云主机处于运行中(running)或关机(stopped)状态
3、目前仅支持多可用区类型资源池,您可以通过资源池列表查询查询资源池信息
URI
POST /v4/ecs/share-interface/attach
路径参数
无
Query参数 无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
subnetID | 是 | String | 子网ID,您可以查看基本概念来查找子网的相关定义 获取: 查 查询子网列表 创 创建子网 注:在多可用区类型资源池下,subnetID通常以“subnet-”开头,非多可用区类型资源池subnetID为uuid格式 |
a90eebf0-d798-5017-b9f0-9468bb2301c2 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
nicID | String | 网卡ID | port-73o2e3utd8 |
请求示例
示例:为云主机添加一块共享网卡
为华东1资源池中一台云主机增加一块共享网卡
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"subnetID": "subnet-4c4333pc67"
}
响应示例
{
"returnObj": {
"nicID": "port-73o2e3utd8"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Ecs.RegionInfo.Empty | 资源池信息为空 |
Ecs.RegionVersion.NotSupported | 当前API不支持该资源池,请切换资源池重试 |
Ecs.Parameter.NotValid | 请求参数非法 |
Openapi.EcsWorkOrder.AccessError | 添加共享网卡失败 |
Openapi.SubnetCheck.NotFound | 子网不存在 |
Ecs.Instance.NotFound | 云主机不存在,请确认云主机ID是否有效 |
Ecs.Common.CheckError | 内部错误,请重试 |
Ecs.Common.TimeOut | 请求超时 |