文档首页/ 虚拟私有云 VPC/ API参考/ API/ VPC/ 查询VPC
更新时间：2024-10-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询VPC

功能介绍

查询虚拟私有云。

URI

GET /v1/{project_id}/vpcs/{vpc_id}

参数说明请参见表1。
表1 参数说明

名称

是否必选

说明

project_id

是

项目ID，获取项目ID请参见获取项目ID。

vpc_id

是

虚拟私有云唯一标识

请求参数

无

请求示例

GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3

响应参数

表2 响应参数

名称

参数类型

说明

vpc

vpc object

vpc对象
表3 vpc对象

名称

参数类型

说明

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：创建成功

routes

Array of route objects
  • 功能说明：路由信息列表。
  • 约束：详情参见route对象。

enterprise_project_id

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

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

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格式，支持IPv4和IPv6 cidr格式

nexthop

String
  • 功能说明：路由下一跳地址
  • 约束：必须为IP地址格式，且必须属于本VPC下的子网范围内才能生效，支持IPv4和IPv6地址

响应示例

{
    "vpc": {
        "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-15T02:25:11",
        "updated_at": "2022-12-15T02:25:11"
}
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： VPC