添加VPC网络实例
接口功能介绍
异步接口，添加VPC网络实例到云间高速，可通过[查询vpc实例]接口返回的实例状态确定实例是否加载完成。
接口约束
无
URI
POST /v4/ec/vpc-instance/create
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 是 | String | 云网关实例ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| rtbID | 是 | String | 路由表ID | 11280584-fe8f-49b0-9e09-ef915caeee10 | |
| dcID | 是 | String | 资源池ID | 5054948f-f9ba-4482-83fa-81cc7d0e5171 | |
| vpcID | 是 | String | vpc ID | vpc-sz-1 | |
| vpcName | 否 | String | 云间高速侧显示的vpc名称（建议保持和vpc创建时的名称一致） | vpc-test | |
| exclusiveID | 否 | String | 专属云资源池ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云网关自动学习网络实例路由 取值范围: 1:学习 0:不学习 默认学习 |
1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云网关路由自动同步到网络实例 取值范围: 1:同步 0:不同步 默认同步 |
1 | |
| subnets | 是 | Array of Objects | subnet列表 | vpc子网信息 | subnet |
表 subnet
| 参数名 | 类型 | 必填 | 含义 |
|---|---|---|---|
| subnetID | String | 是 | 子网ID, 填写错误会导致异步加载失败，导致回滚 |
| IPVersion | String | 是 | 子网类型 取值范围: "IPV4":IPv4类型 "IPV6":IPv6类型 |
| CIDR | String | 是 | 子网CIDR |
| subnetName | String | 是 | 子网名称 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| oplogID | 否 | String | 操作日志id | 66d1ad0b-a4c6-4fb8-80f5-0cb08943f49f |
请求示例
请求头header
请求体body
{
"ecID": "50230948f-f9ba-4482-83fa-81cc7d0e5171",
"cgwID": "5120948f-f9ba-4482-83fa-81cc7d0e5171",
"rtbID": "5430948f-f9ba-4482-83fa-81cc7d0e5171",
"dcID": "5054948f-f9ba-4482-83fa-81cc7d0e5171",
"vpcID": "vpc-sz-1",
"vpcName":"vpc-test",
"routeLearn":1,
"routeSync":1,
"subnets": [{
"subnetID": "sub-sz-2",
"IPVersion": "IPV4",
"CIDR": "192.168.122.0/24",
"subnetName":"subnet-user1"
},
{
"subnetID": "sub-sz-1",
"IPVersion": "IPV6",
"CIDR": "2001:da8:201:1512::a269:83a0/128",
"subnetName":"subnet-user2"
}
]
}
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "bc9a70eb-28d7-4032-9510-1bea00192f34",
"returnObj": {
"oplogID": "66d1ad0b-a4c6-4fb8-80f5-0cb08943f49f"
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.NetworksEc.CreateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
