查询VPC列表
更新时间：2021-12-24
接口描述
本接口用来查询VPC列表信息。
请求结构
GET /v1/vpc?regionId={regionId}&pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页号，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 查询返回每页个数，取值范围为1～100，缺省值为100 |
| keywordType | String | 否 | Query参数 | 查询实例的关键字类型，取值为vpcId、vpcName |
| keyword | String | 否 | Query参数 | 查询的关键字值 |
| regionId | String | 否 | Query参数 | 节点ID。用于查询所属节点的资源 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<Vpc> | VPC列表数据 |
| orderBy | String | 排序字段，缺省为createTime |
| order | String | 排序顺序,取值为DESC、ASC，分别表示为降序、升序。缺省为DESC |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
请求示例
GET /v1/vpc HTTP/1.1
Host: bec.baidubce.com
ContentType: application/json
Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de 返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
Date: Thu, 16 Mar 2021 06:29:48 GMT
Content Type: application/json;charset=UTF 8
Server: BWS
{
"result": [
{
"vpcId": "vpc-qbrgnre6",
"name": "test1",
"cidr": "172.16.0.0/20",
"description": "",
"city": "HANGZHOU",
"serviceProvider": "CHINA_MOBILE",
"region": "EAST_CHINA",
"regionId": "cn-hangzhou-cm",
"createdTime": "2021-11-12T03:28:04Z",
"isDefault": true
},
{
"vpcId": "vpc-pe9hy3pn",
"name": "test2",
"cidr": "192.168.0.0/16",
"description": "",
"city": "CHANGCHUN",
"serviceProvider": "TRIPLE_LINE",
"region": "NORTH_EAST",
"regionId": "cn-changchun-ix",
"createdTime": "2021-11-15T06:28:38Z",
"isDefault": false
}
],
"orderBy": "createTime",
"order": "desc",
"pageNo": 1,
"pageSize": 100,
"totalCount": 2
}错误码
请参照错误返回章节的内容。
Model对象定义
Vpc
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vpcId | String | VPC ID |
| name | String | VPC名称 |
| cidr | String | VPC 网段及子网掩码CIDR |
| description | String | VPC 描述 |
| region | String | 地域 |
| serviceProvider | String | 运营商 |
| city | String | 城市 |
| regionId | String | 节点ID |
| isDefault | Boolean | 是否节点默认VPC，true：是；false：否 |
| createdTime | String | VPC创建时间（UTC） |