文档首页 > > API参考> API> VPC> 查询VPC列表

查询VPC列表

分享
更新时间: 2019/08/31 18:43

功能介绍

查询虚拟私有云列表。

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

marker

String

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

limit

Integer

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

enterprise_project_id

String

  • 功能说明:企业项目ID。可以使用该字段过滤某个企业项目下的虚拟私有云。
  • 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的虚拟私有云,请传参all_granted_eps
说明:

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

请求消息

  • 请求参数

  • 请求样例
    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:创建成功

    enterprise_project_id

    String

    • 功能说明:企业项目ID。
    • 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的虚拟私有云,请传参all_granted_eps

    routes

    Array of route objects

    • 功能说明:路由信息列表
    • 约束:详情参见表4
    表4 route对象

    名称

    参数类型

    说明

    destination

    String

    • 功能说明:路由目的网段
    • 约束:必须是cidr格式,且目前只支持0.0.0.0/0

    nexthop

    String

    • 功能说明:路由下一跳地址
    • 约束:必须为IP地址格式,且必须属于本VPC下的子网范围内才能生效
  • 响应样例
    {
        "vpcs": [
            {
                "id": "13551d6b-755d-4757-b956-536f674975c0",
                "name": "default",
                "description": "test",
                "cidr": "172.16.0.0/16",
                "status": "OK",
                "enterprise_project_id": "0",
                "routes": []
            },
            {
                "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
                "name": "222",
                "description": "test",
                "cidr": "192.168.0.0/16",
                "status": "OK",
                "enterprise_project_id": "0635d733-c12d-4308-ba5a-4dc27ec21038",
                "routes": []
            },
            {
                "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
                "name": "vpc",
                "description": "test",
                "cidr": "192.168.0.0/16",
                "status": "OK",
                "enterprise_project_id": "0",
                "routes": []
            }
        ]
    }

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区