接口说明
本接口用于更换虚拟私有云VPC,支持对单台实例绑定的多张网卡同时更换虚拟私有云。更换虚拟私有云后,您可以通过查询云主机虚拟网卡列表接口查询是否更换成功。
注意事项:
-
目标子网必须与实例处于同一可用区。
-
一次最多支持更换10张网卡。
-
仅
active(运行中)或shutoff(已关机)状态的实例支持,其他中间状态不支持。 -
指定IP地址更换时,仅支持IPv4,不支持IPv6。
-
更换虚拟私有云后,请重新配置弹性公网IP和其他网络服务,如SLB、VPN、NAT、DNS等。
-
如原网卡已开通IPv6带宽,更换虚拟私有云后新网卡不会自动开通IPv6带宽,请您重新开通。
-
更换虚拟私有云的过程中,请勿操作对应网卡的弹性公网IP,或对实例做其他操作。
-
如指定
newPortId,则参数vpcId、networkId、privateIp不生效。 -
如未指定
newPortId,则参数networkId、securityGroupIds必填。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/network/replace-instances-vpc
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
replaceInstancesVpcReq
|
ReplaceInstancesVpcReq
|
是
|
replaceInstancesVpcReq |
|
instanceId
|
string
|
是
|
实例ID。可通过查询实例状态列表接口获取。 |
|
vpcPorts
|
<VpcPort> array
|
是
|
更换虚拟私有云数组。 |
|
vpcId
|
string
|
否
|
目标虚拟私有云的ID。可通过分页查询VPC列表接口获取。 |
|
networkId
|
string
|
否
|
网络ID,可通过分页查询子网列表接口获取。 |
|
oldPortId
|
string
|
是
|
需要解绑的实例网卡ID。可通过查询实例详情接口获取。 |
|
newPortId
|
string
|
否
|
需要绑定的实例网卡ID。可通过查询虚拟网卡列表接口获取。 |
|
securityGroupIds
|
<string> array
|
否
|
安全组ID列表,最多指定5个安全组。可通过查询安全组列表接口获取。 |
|
privateIp
|
string
|
否
|
新的指定IPv4地址。默认值:当不传该值时,系统将自动分配。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/network/replace-instances-vpc
{
"instanceId":"7a93a490-acf1-4a66-a8ea-6698bc72ff9b",
"vpcPorts":[
{
"oldPortId":"eb6043d9-***-cca0a4f2cf2e",
"networkId":"55daa6a7-6916-4fed-a8fd-e0e8296677f1",
"securityGroupIds":[
"xxx"
]
},
{
"newPortId":"eb6043d9-9213-46d3-930a-cca0a4f2cf2e",
"oldPortId":"eb6043d9-***-cca0a4f2cf2e"
}
]
}
返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
BatchAction«InstanceActionResult»
|
请求成功时返回的数据。 |
|
instanceBatchResult
|
<InstanceActionResult> array
|
实例批量操作结果集。 |
|
instanceId
|
string
|
实例ID。 |
|
oldPortId
|
string
|
旧网卡ID。 |
|
result
|
boolean
|
操作是否下发成功。 |
|
message
|
string
|
操作结果信息,失败时返回错误信息,成功时返回空字符串。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。 |
返回示例
{
"requestId":"reqId-49b078faacbc1dc85d66c-8e359238-7",
"state":"OK",
"body":{
"instanceBatchResult":[
{
"instanceId":"fa42141d-eb0d-4915-bef0-****",
"oldPortId":"eb6043d9-***-cca0a4f2cf2e",
"result":true,
"message":""
},
{
"instanceId":"fa42141d-eb0d-4915-bef0-****",
"oldPortId":"eb6043d9-***-cca0a4f2cf2e",
"result":true,
"message":""
}
]
}
}