查询VPC网络实例详情
接口功能介绍
查看指定VPC网络实例详情
接口约束
无
URI
POST /v4/ec/vpc-instance/get
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 是 | String | 云网关ID | gateway_beijing | |
| instanceID | 是 | String | 指定网络实例UUID | 123f8a86-8729-4e62-b2e4-f228bccba3ce |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表 results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 否 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关ID | 82c40584-fe8f-49b0-9e09-ef915caeee11 | |
| cgwName | 否 | String | 云网关名称 | gateway_beijing | |
| status | 否 | String | 指定状态描述 取值包括： "creating"：加载中 "running"：已连接 "removing"：卸载中 "flushing"：路由待更新 "error"：失败 |
running | |
| vpcName | 否 | String | 网络实例名称 | vpc-1 | |
| vpcID | 否 | String | vpc ID | vpc-nm-1 | |
| vpcCIDR | 否 | String | 网络实例CIDR | 192.168.0.0/16 | |
| dcName | 否 | String | 资源池名称 | 内蒙演示环境 | |
| dcID | 否 | String | 资源池ID信息 | 81f7728662dd11ec810800155d307d5b | |
| dcType | 否 | String | 资源池类型， 取值范围: "CNP":CNP资源池 "MAZ":MAZ资源池 "OS":OS资源池 "CS":CS资源池 "PRVT":私有云资源池 |
MAZ | |
| rtbName | 否 | String | 路由表名称 | route-f91e | |
| rtbID | 否 | String | 路由表ID | route-0ddafc | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
| subnetList | 否 | Array of Objects | 子网信息 | subnetList | |
| exclusiveID | 否 | String | 专属云资源池ID | 81f7728662dd11ec810800155d307d5b | |
| instanceID | 否 | String | vpc网络实例UUID | 123f8a86-8729-4e62-b2e4-f228bccba3ce | |
| isAuth | 否 | Integer | 是否是跨账号实例 取值包括： 0:本账号 1:跨账号 |
0 | |
| isExclusive | 否 | Integer | 是否是专属云实例 取值包括： 0:公有云 1:专属云 |
1 | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云网关自动学习网络实例路由 取值范围: 1:学习 0:不学习 默认学习 |
1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云网关路由自动同步到网络实例 取值范围: 1:同步 0:不同步 默认同步 |
1 |
表 subnetList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| gateway | 否 | String | IPv4网关 | 10.27.1.1 | |
| CIDR | 否 | String | 子网IPv4 CIDR | 10.27.1.0/24 | |
| subnetID | 否 | String | 子网IPv4 ID | subnet-l21t1k0psj | |
| IPVersion | 否 | String | IP类型，取值范围 IPv6：IPv6类型 IPv4：IPv4类型 |
IPv4 | |
| subnetName | 否 | String | 子网名称 | subnet-f91e |
请求示例
请求头header
请求体body
{
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"cgwID": "gateway_beijing",
"instanceID": "123f8a86-8729-4e62-b2e4-f228bccba3ce",
}
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"status": "running",
"cgwName": "gateway-d197",
"ecID": "ed908e5e-fc66-4aa1-b6b8-662ec1f99c2b",
"vpcCIDR": "192.168.0.0/16",
"exclusiveID":"",
"rtbName": "route-f34e",
"dcID": "81f7728662dd11ec810800155d307d5b",
"rtbID": "f79bb3f7-f072-4368-a983-c609b59eb907",
"dcType": "MAZ",
"vpcName": "vpc-6b0e",
"createDate": "2022-09-19 02:05:28",
"subnetList": [{
"subnetName": "subnet-6b0e",
"CIDR": "192.168.0.0/24",
"subnetID": "subnet-fk3ju6wl4l",
"gateway": "192.168.0.1",
"IPVersion": "IPv4"
}],
"cgwID": "90cc8ba8-8779-4167-b64e-e2690d349756",
"dcName": "内蒙演示环境",
"vpcID": "vpc-abgdaqjm3y",
"instanceID":"59eb3f7-f072-4368-a983-c6093f7wb907",
"isAuth":0,
"isExclusive":0,
"routeLearn":1,
"routeSync":1
}]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.NetworksEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
