华为云计算 云知识 查询VPC列表ListVpcs
查询VPC列表ListVpcs

 

功能介绍

查询 虚拟私有云 列表。

调试

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

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,表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用:

  • 若不传入marker和limit参数,查询结果返回第一页全部资源记录。
  • 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11条及之后的所有资源记录。

limit

Integer

分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。

limit需要和marker配合使用,详细规则请见marker的参数说明。

ent erp rise_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~24
    • 172.16.0.0/12~24
    • 192.168.0.0/16~24
  • 不指定cidr时,默认值为空
  • 约束:必须是cidr格式,例如:192.168.0.0/16

status

String

  • 功能说明:虚拟私有云的状态。
  • 取值范围:
    • CREATING:创建中
    • OK:创建成功

enterprise_project_id

String

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

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

routes

Array of route objects

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

tenant_id

String

功能说明:项目ID。

created_at

String

  • 功能说明:资源创建时间,UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ss

updated_at

String

  • 功能说明:资源更新时间,UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ss
表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": [],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T02:11:13",
            "updated_at": "2022-12-15T02:11:13"
        },
        {
            "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": [],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T04:01:21",
            "updated_at": "2022-12-15T04:01:21"
        },
        {
            "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
            "name": "vpc",
            "description": "test",
            "cidr": "192.168.0.0/16",
            "status": "OK",
            "enterprise_project_id": "0",
            "routes": [],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T05:36:29",
            "updated_at": "2022-12-15T05:36:29"
        }
    ]
}

状态码

请参见状态码

错误码

请参考错误码

 

上一篇:前信数智工厂使用指导-看板报表 下一篇:GaussDB(for MySQL)数据库强悍性能支撑业务拓展

虚拟私有云 VPC

虚拟私有云(Virtual Private Cloud)是用户在华为云上申请的隔离的、私密的虚拟网络环境。用户可以自由配置VPC内的IP地址段、子网、安全组等子服务,也可以申请弹性带宽和弹性IP搭建业务系统