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

查询VPC详情

功能介绍

查询VPC详情。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方式请参见获取项目ID。

vpc_id

是

String

VPC资源ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

vpc

Vpc object

VPC响应体。
表3 Vpc

参数

参数类型

描述

id

String

  • 功能描述：VPC对应的唯一标识。

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

name

String

  • 功能说明：VPC对应的名称。

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

description

String

  • 功能说明：VPC的描述信息。

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

cidr

String

  • 功能说明：VPC下可用子网的范围。

  • 取值范围：

    • 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时，默认值为“”。

  • 约束：必须是ipv4 cidr格式，例如:192.168.0.0/16。

extend_cidrs

Array of strings

  • 功能描述：VPC的扩展网段。

  • 约束：目前只支持ipv4。

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关联资源类型和数量。

  • 取值范围：目前只返回VPC关联的routetable和virsubnet。virsubnet数量为ipv4和ipv6子网总数。

tags

Array of Tag objects

  • 功能说明：VPC的标签信息，详情参见Tag对象。

  • 取值范围：0-20个标签键值对。
表4 CloudResource

参数

参数类型

描述

resource_type

String

  • 功能描述：资源类型。

resource_count

Integer

  • 功能说明：资源数量。

缺省值：0
表5 Tag

参数

参数类型

描述

key

String

  • 功能说明：标签键。

  • 取值范围：

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

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

    • 可以包含的字符范围：

      • 英文字母

      • 数字

      • 特殊字符：下划线（_）、中划线（-）

      • 中文字符

value

String

  • 功能描述：标签值。

  • 取值范围：

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

    • 可以包含的字符范围：

      • 英文字母

      • 数字

      • 特殊字符：下划线（_）、中划线（-）、点（.）

      • 中文字符

请求示例

查询vpc详情。

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

响应示例

状态码： 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操作正常返回，更多状态码请参见状态码。

错误码

请参见错误码。

父主题： VPC