查询VPC列表
功能介绍
查询vpc列表。
接口约束
查询提交请求的租户有权限查看的所有vpc信息，单次查询最多返回2000条数据，超过2000后会返回分页标记
URI
GET /v3/{project_id}/vpc/vpcs
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
功能说明：每页返回的个数 取值范围：0-2000 |
|
marker |
否 |
String |
分页查询起始的资源ID，为空时查询第一页 |
|
id |
否 |
Array of strings |
VPC资源ID。可以使用该字段过滤VPC |
|
name |
否 |
Array of strings |
VPC的name信息，可以使用该字段过滤VPC |
|
description |
否 |
Array of strings |
VPC的描述信息。可以使用该字段过滤VPC |
|
cidr |
否 |
Array of strings |
VPC的CIDR。可以使用该字段过滤VPC |
请求参数
无
请求示例
- 查询VPC列表
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs"
- 使用ID过滤查询VPC列表
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?id=01ab4be1-4447-45fb-94be-3ee787ed4ebe&id=02cd5ef2-4447-36fb-75be-3ee787ed6adf" - 使用name过滤查询VPC列表
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?name=vpc-test" - 分页查询VPC列表
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe"
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求ID |
|
vpcs |
Array of Vpc objects |
VPC列表响应体 |
|
page_info |
PageInfo object |
分页信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
功能描述：VPC对应的唯一标识 取值范围：带“-”的UUID格式 |
|
name |
String |
功能说明：VPC对应的名称 取值范围：0-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） |
|
description |
String |
功能说明：VPC的描述信息 取值范围：0-255个字符，不能包含“<”和“>” |
|
cidr |
String |
功能说明：VPC下可用子网的范围 取值范围：
不指定cidr时，默认值为“”
|
|
extend_cidrs |
Array of strings |
功能描述：VPC的扩展网段 取值范围： 约束：目前只支持ipv4 |
|
status |
String |
功能说明：VPC对应的状态
取值范围：
|
|
project_id |
String |
功能说明：VPC所属的项目ID |
|
created_at |
String |
功能说明：VPC创建时间 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
功能说明：VPC更新时间 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss |
|
cloud_resources |
Array of CloudResource objects |
功能说明：VPC关联资源类型和数量 取值范围：目前只返回VPC关联的routetable和virsubnet。virsubnet数量为ipv4和ipv6子网总数 |
响应示例
{
"request_id": "9c1838ba498249547be43dd618b58d27",
"vpcs": [
{
"id": "01da5a65-0bb9-4638-8ab7-74c64e24a9a7",
"name": "API-PERF-TEST-14bd44c121",
"description": "",
"cidr": "192.168.0.0/16",
"extend_cidrs": [ ],
"status": "ACTIVE",
"project_id": "087679f0aa80d32a2f4ec0172f5e902b",
"created_at": "2020-06-16T02:32:18Z",
"updated_at": "2020-06-16T02:32:18Z",
"cloud_resources": [
{
"resource_type": "routetable",
"resource_count": 1
},
{
"resource_type": "virsubnet",
"resource_count": 0
}
]
},
{
"id": "43fd79b0-f7d7-4e9b-828b-2d4d7bfae428",
"name": "API-PERF-TEST_m2n33",
"description": "",
"cidr": "192.168.0.0/16",
"extend_cidrs": [ ],
"status": "ACTIVE",
"project_id": "087679f0aa80d32a2f4ec0172f5e902b",
"created_at": "2020-06-15T06:29:40Z",
"updated_at": "2020-06-15T06:29:41Z",
"cloud_resources": [
{
"resource_type": "routetable",
"resource_count": 1
},
{
"resource_type": "virsubnet",
"resource_count": 1
}
]
},
{
"id": "5ed053ba-b46c-4dce-a1ae-e9d8a7015f21",
"name": "API-PERF-TEST-c34b1c4b12",
"description": "",
"cidr": "192.168.0.0/16",
"extend_cidrs": [ ],
"status": "ACTIVE",
"project_id": "087679f0aa80d32a2f4ec0172f5e902b",
"created_at": "2020-06-16T02:32:33Z",
"updated_at": "2020-06-16T02:32:33Z",
"cloud_resources": [
{
"resource_type": "routetable",
"resource_count": 1
},
{
"resource_type": "virsubnet",
"resource_count": 0
}
]
}
],
"page_info": {
"previous_marker": "01da5a65-0bb9-4638-8ab7-74c64e24a9a7",
"current_count": 3
}
}
状态码
请参见状态码。
错误码
请参见错误码。
