接口功能介绍
查询用户专线网关下添加的VPC信息
接口结束
无
URI
GET /v4/cda/vpc/list
路径参数
无
Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vrfName | 是 | String | 专线网关ID |
请求参数
请求头 header 参数
无
请求体 body 参数
无
响应参数
| 参数 | 参数类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| error | String | 错误 | ||
| details | String | 错误明细 |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpcList | Array of Object | VPC列表 | VPC |
表VPC
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| account | String | 天翼云账号 | ||
| vpcID | String | VPC ID | ||
| vrfName | String | 专线网关ID | ||
| dcType | String | 本参数表示资源池类型。 取值范围： MAZ CNP |
||
| vpcSubnet | String | VPC子网 | ||
| resourcePool | String | 资源池ID | ||
| ipVersion | String | 本参数表示包周期类型。 取值范围： IPV4 IPV6 DUALSTACK |
||
| bandwidth | Integer | 虚拟带宽 | ||
| vpcName | String | VPC名字 | ||
| vpcSubnetIPv6 | String | VPC IPv6子网 | ||
| vpcNetworkSegment | String | VPC网段 | ||
| ctUserId | String | 天翼云用户ID | ||
| vpcNetworkSegmentIPv6 | String | VPC IPv6网段 |
请求示例
请求url
/v4/cda/vpc/list?vrfName=nm8CTYUN12
请求头
无
请求体 body
无
响应示例
{
"returnObj": {
"vpcList": [{
"account": "gmm-cdatest@qq.com",
"vpcId": "vpc-egiywe8ngw",
"vrfName": "nm8CTYUN12",
"dcType": "EMAZ",
"vpcSubnet": "192.168.33.0/24",
"resourcePool": "81f7728662dd11ec810800155d307d5b",
"ipVersion": "IPV4",
"bandwidth": 300,
"vpcName": "vpc-hjjj",
"emazIdV6": null,
"vpcSubnetIPv6": "",
"vpcNetworkSegment": "192.168.0.0/16",
"ctUserId": "bac_2f5cf4a12cb94c4eac336a632822df5f",
"vpcNetworkSegmentIPv6": null
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.CDA.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
