更新时间:2022-04-17 GMT+08:00
分享

查询VPC列表

功能介绍

查询vpc列表

接口约束

查询提交请求的租户有权限查看的所有vpc信息,单次查询最多返回2000条数据,超过2000后会返回分页标记

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/vpc/vpcs

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID。

获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

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"

响应参数

表3 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

vpcs

Array of Vpc objects

VPC列表响应体

page_info

PageInfo object

分页信息

表4 Vpc

参数

参数类型

描述

id

String

功能描述:VPC对应的唯一标识

取值范围:带“-”的UUID格式

name

String

功能说明:VPC对应的名称

取值范围:0-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

description

String

功能说明:VPC的描述信息

取值范围:0-255个字符,不能包含“<”和“>”

cidr

String

功能说明:VPC下可用子网的范围

取值范围:

  • 10.0.0.0/8~10.255.255.240/28
  • 172.16.0.0/12 ~ 172.31.255.240/28
  • 192.168.0.0/16 ~ 192.168.255.240/28

不指定cidr时,默认值为“”

  • 约束:必须是ipv4 cidr格式,例如:192.168.0.0/16

extend_cidrs

Array of strings

功能描述:VPC的扩展网段

取值范围:

约束:目前只支持ipv4

status

String

功能说明:VPC对应的状态

取值范围:
  • PENDING:创建中
  • ACTIVE:创建成功

project_id

String

功能说明:VPC所属的项目ID

enterprise_project_id

String

功能说明:VPC所属的企业项目ID。

取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

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

tags

Array of Tag objects

功能说明:VPC的标签信息,详情参见Tag对象

取值范围:0-10个标签键值对

表5 CloudResource

参数

参数类型

描述

resource_type

String

功能描述:资源类型

resource_count

Integer

功能说明:资源数量

表6 Tag

参数

参数类型

描述

key

String

功能说明:标签键

取值范围:
  • 最大长度36个unicode字符。
  • key不能为空。不能包含非打印字符ASCII(0-31),*,<,>,,=

value

String

功能描述:标签值

取值范围:

  • 每个值最大长度43个unicode字符,可以为空字符串。
  • 不能包含非打印字符ASCII(0-31),*,<,>,,=
表7 PageInfo

参数

参数类型

描述

previous_marker

String

当前页第一条记录

current_count

Integer

当前页总数

next_marker

String

当前页最后一条记录,最后一页时无next_marker字段

响应示例

{
    "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", 
            "enterprise_project_id": "0", 
            "tags": [ ], 
            "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", 
            "enterprise_project_id": "0", 
            "tags": [ ], 
            "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", 
            "enterprise_project_id": "0", 
            "tags": [ ], 
            "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
    }
}

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品

close