更新时间:2022-01-25 GMT+08:00

查询VPC列表

功能介绍

查询虚拟私有云列表。

URI

GET /v1/{project_id}/vpcs

样例:
GET https://{Endpoint}/v1/{project_id}/vpcs?limit=10&marker=13551d6b-755d-4757-b956-536f674975c0
参数说明请参见表1
表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID,获取项目ID请参见获取项目ID

marker

String

分页查询起始的资源ID,为空时为查询第一页

limit

Integer

  • 功能说明:每页返回的个数
  • 取值范围:0~intmax

请求消息

  • 请求参数

  • 请求样例
    GET https://{Endpoint}/v1/{project_id}/vpcs

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    vpcs

    Array of vpcs objects

    vpc对象

    表3 vpcs字段说明

    名称

    参数类型

    说明

    id

    String

    uuid形式的一个资源标识。

    name

    String

    • 功能说明:虚拟私有云名称
    • 取值范围:0-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)
    • 约束:如果名称不为空,则同一个租户下的名称不能重复

    description

    String

    • 功能说明:虚拟私有云描述
    • 取值范围:0-255个字符,不能包含“<”和“>”。

    cidr

    String

    • 功能说明:虚拟私有云下可用子网的范围
    • 取值范围:
      • 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时,默认值为空
    • 约束:必须是cidr格式,例如:192.168.0.0/16

    status

    String

    • 功能说明:虚拟私有云的状态。
    • 取值范围:
      • CREATING:创建中
      • OK:创建成功
  • 响应样例
    {
        "vpcs": [
            {
                "id": "13551d6b-755d-4757-b956-536f674975c0",
                "name": "default",
                "description": "test",
                "cidr": "172.16.0.0/16",
                "status": "OK"
                
            },
            {
                "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
                "name": "222",
                "description": "test",
                "cidr": "192.168.0.0/16",
                "status": "OK"
                
            },
            {
                "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
                "name": "vpc",
                "description": "test",
                "cidr": "192.168.0.0/16",
                "status": "OK"
                
            }
        ]
    }

状态码

请参见状态码

错误码

请参考错误码