云主机添加共享网卡
接口功能介绍
给云主机添加共享网卡
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
- 云主机处于运行中(running)或关机(stopped)状态
- 目前仅支持多可用区类型资源池
URI
POST /v4/ecs/attach-share-interface
路径参数
无
Query参数 无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | ||
azName | 否 | String | 可用区名称。您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | ||
ID | 是 | String | 云主机实例ID | ||
subnetID | 是 | String | vpc子网ID |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
portID | String | 创建的网卡ID |
请求示例
{
"regionID":"666666666zhangzeyu6666666",
"azName":"az1",
"ID": "a4bab1a7-f7b3-1ffe-b9b1-e5edbac84ab0",
"subnetID": "e84256c3-3c5f-49f7-a89b-a1e55d8f1143"
}
响应示例
{
"returnObj": {
"portID": "e84256c3-3c5f-49f7-a89b-a1e55d8f1143"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Ecs.Parameter.InvalidNotValid | 请求参数非法 |
Ecs.RegionVersion.NotSupported | 当前API不支持该资源池,请切换资源池重试 |
Openapi.Ecsworkorder.ActionError | 添加共享网卡失败 |
Ecs.EcsCheck.NotFound | 找不到云主机 |
Ecs.State.NotValid | 云主机状态非法 |
Ecs.Common.CheckError | 内部错误,请重试 |
Ecs.Common.TimeOut | 请求超时 |