接口功能介绍
网卡关联辅助私网IPs
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 使用限制,本接口只支持在华东1、上海32、上海33、上海36、南宁23、南昌19、青岛20、青岛21、武汉41资源池进行公测
2. secondaryPrivateIps和secondaryPrivateIpCount在同一次请求中,两个字段同时只能传一个,且必须保证至少传一个
URI
POST /v4/ecs/ports/assign-secondary-private-ips
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,则代表为同一个请求。保留时间为24小时 | assign-secondary-private-ips-01 | |
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
networkInterfaceID | 是 | String | 网卡ID,您可以查看弹性网卡-弹性网卡基本知识来了解弹性网卡 获取: 查 查询弹性网卡列表 创 创建弹性网卡 |
port-vibsmse8pl | |
secondaryPrivateIps | 否 | Array of Strings | 辅助私网IP列表,新增辅助私网IP,与secondaryPrivateIpCount二选一 | ["172.16.0.210"] | |
secondaryPrivateIpCount | 否 | Integer | 辅助私网IP数量,新增自动分配辅助私网IP的数量,与secondaryPrivateIps二选一 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 | 失败时的错误描述 | 成功 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:网卡关联两个辅助私网IP
{
"clientToken": "assign-secondary-private-ips-01" ,
"regionID": "bb9fdb42056f11eda1610242ac110002",
"networkInterfaceID": "port-pja7l0zfvk",
"secondaryPrivateIps": ["192.168.0.1", "192.168.0.2"]
}
响应示例
{
"returnObj": {
"secondaryPrivateIps": [
"172.16.0.210"
]
},
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码