更新时间:2026-01-09 GMT+08:00

查询VPC详情

功能介绍

当您的VPC创建成功后,您可以通过调用此接口查询单个VPC的详细信息,包括VPC名称、ID、网段等。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/vpc/vpcs/{vpc_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

  • 参数解释:VPC所属的项目ID。

  • 取值范围:无

vpc_id

String

  • 参数解释:VPC资源ID,是VPC对应的唯一标识。

  • 取值范围:无

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

vpc

Vpc object

  • 参数解释:查询VPC详情响应体。

  • 取值范围:无

表3 Vpc

参数

参数类型

描述

id

String

  • 参数解释:VPC资源ID。VPC创建成功后,会生成一个VPC ID,是VPC对应的唯一标识。

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

name

String

  • 参数解释:VPC的名称。

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

description

String

  • 参数解释:VPC的描述信息。

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

cidr

String

  • 参数解释:VPC下可用子网的范围。

  • 取值范围:

    • 10.0.0.0/8-24:IP地址范围为10.0.0.0-10.255.255.255,掩码范围为8~24。

    • 172.16.0.0/12-24:IP地址范围为172.16.0.0-172.31.255.255,掩码范围为12~24。

    • 192.168.0.0/16-24:IP地址范围为192.168.0.0-192.168.255.255,掩码范围为16~24。

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

extend_cidrs

Array of strings

  • 参数解释:VPC的扩展网段。

  • 取值范围:不能包含以下网段。

    • 10.0.0.0/8:IP地址范围为10.0.0.0-10.255.255.255。

    • 172.16.0.0/12:IP地址范围为172.16.0.0-172.31.255.255。

    • 192.168.0.0/16:IP地址范围为192.168.0.0-192.168.255.255。

    • 172.31.0.0/16:IP地址范围为172.31.0.0-172.31.255.255。

    • 100.64.0.0/10:IP地址范围为100.64.0.0-100.127.255.255。

    • 214.0.0.0/7:IP地址范围为214.0.0.0-215.255.255.255。

    • 198.18.0.0/15:IP地址范围为198.18.0.0-198.19.255.255。

    • 169.254.0.0/16:IP地址范围为169.254.0.0-169.254.255.255。

    • 0.0.0.0/8:IP地址范围为0.0.0.0-0.255.255.255。

    • 127.0.0.0/8:IP地址范围为127.0.0.0-127.255.255.255。

    • 240.0.0.0/4:IP地址范围为240.0.0.0-255.255.255.255。

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:ssZ。

updated_at

String

  • 参数解释:VPC更新时间。

  • 取值范围:UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

cloud_resources

Array of CloudResource objects

  • 参数解释:VPC关联资源类型和数量。例如子网、路由表等云资源。

  • 取值范围:无

tags

Array of ResponseTag objects

  • 参数解释:VPC的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。

  • 取值范围:无

表4 CloudResource

参数

参数类型

描述

resource_type

String

  • 参数解释:资源类型。

  • 取值范围:无

resource_count

Integer

  • 参数解释:资源数量。

  • 取值范围:无

表5 ResponseTag

参数

参数类型

描述

key

String

参数解释

标签键。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

value

String

参数解释

标签值。

取值范围

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、冒号(:)、加号(+)、中划线(-)、等号(=)

请求示例

查询vpc详情。

GET https://{Endpoint}/v3/{project_id}/vpc/vpcs/0552091e-b83a-49dd-88a7-4a5c86fd9ec3

响应示例

状态码:200

GET操作正常返回,更多状态码请参见状态码

{
  "request_id" : "84eb4f775d66dd916db121768ec55626",
  "vpc" : {
    "id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
    "name" : "name-test",
    "description" : "description-test",
    "cidr" : "192.168.0.0/16",
    "extend_cidrs" : [ "21.8.0.0/16" ],
    "enterprise_project_id" : "0",
    "tags" : [ {
      "key" : "key",
      "value" : "value"
    } ],
    "cloud_resources" : [ {
      "resource_type" : "routetable",
      "resource_count" : 1
    } ],
    "status" : "ACTIVE",
    "project_id" : "060576782980d5762f9ec014dd2f1148",
    "created_at" : "2018-03-23T09:26:08",
    "updated_at" : "2018-08-24T08:49:53"
  }
}

状态码

状态码

描述

200

GET操作正常返回,更多状态码请参见状态码

错误码

请参见错误码