/ 虚拟私有云 vpc/ api参考/ / / 查询vpc列表
更新时间：2025-01-07 gmt 08:00
查看pdf

查询vpc列表-九游平台

功能介绍

查询vpc列表。

接口约束

查询提交请求的租户有权限查看的所有vpc信息，单次查询最多返回2000条数据，超过2000后会返回分页标记。

调试

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

uri

get /v3/{project_id}/vpc/vpcs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

项目id。

获取方式请参见获取项目id。
表2 query参数

参数

是否必选

参数类型

描述

limit

否

integer

  • 功能说明：每页返回的个数。

  • 取值范围：0-2000。

marker

否

string

  • 功能说明：分页查询起始的资源id，为空时查询第一页。

id

否

array of strings

  • 功能说明：vpc资源id，可以使用该字段过滤vpc。

name

否

array of strings

  • 功能说明：vpc的name信息，可以使用该字段过滤vpc。

description

否

array of strings

  • 功能说明：vpc的描述信息，可以使用该字段过滤vpc。

cidr

否

array of strings

  • 功能说明：vpc的cidr，可以使用该字段过滤vpc。

请求参数

无

响应参数

状态码： 200

表3 响应body参数

参数

参数类型

描述

request_id

string

请求id。

vpcs

array of vpc objects

vpc列表响应体。

page_info

pageinfo object

分页信息。
表4 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个标签键值对。
表5 cloudresource

参数

参数类型

描述

resource_type

string

  • 功能描述：资源类型。

resource_count

integer

  • 功能说明：资源数量。

缺省值：0
表6 tag

参数

参数类型

描述

key

string

  • 功能说明：标签键。

  • 取值范围：

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

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

    • 可以包含的字符范围：

      • 英文字母

      • 数字

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

      • 中文字符

value

string

  • 功能描述：标签值。

  • 取值范围：

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

    • 可以包含的字符范围：

      • 英文字母

      • 数字

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

      • 中文字符
表7 pageinfo

参数

参数类型

描述

previous_marker

string

当前页第一条记录。

current_count

integer

当前页总数。

next_marker

string

当前页最后一条记录，最后一页时无next_marker字段。

请求示例

  • 查询vpc列表。

    get https://{endpoint}/v3/{project_id}/vpc/vpcs

  • 使用id过滤查询vpc列表。

    get https://{endpoint}/v3/{project_id}/vpc/vpcs?id=01ab4be1-4447-45fb-94be-3ee787ed4ebe&id=02cd5ef2-4447-36fb-75be-3ee787ed6adf

  • 使用name过滤查询vpc列表。

    get https://{endpoint}/v3/{project_id}/vpc/vpcs?name=vpc-test

  • 分页查询vpc列表。

    get https://{endpoint}/v3/{project_id}/vpc/vpcs?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe

响应示例

状态码： 200

get操作正常返回，更多状态码请参见状态码。

{
  "request_id" : "9c1838ba498249547be43dd618b58d27",
  "vpcs" : [ {
    "id" : "01da5a65-0bb9-4638-8ab7-74c64e24a9a7",
    "name" : "api-perf-test-14bd44c121",
    "description" : "",
    "cidr" : "192.168.0.0/16",
    "extend_cidrs" : [ ],
    "status" : "active",
    "project_id" : "087679f0aa80d32a2f4ec0172f5e902b",
    "enterprise_project_id" : "0",
    "tags" : [ ],
    "created_at" : "2020-06-16t02:32:18z",
    "updated_at" : "2020-06-16t02:32:18z",
    "cloud_resources" : [ {
      "resource_type" : "routetable",
      "resource_count" : 1
    }, {
      "resource_type" : "virsubnet",
      "resource_count" : 0
    } ]
  }, {
    "id" : "43fd79b0-f7d7-4e9b-828b-2d4d7bfae428",
    "name" : "api-perf-test_m2n33",
    "description" : "",
    "cidr" : "192.168.0.0/16",
    "extend_cidrs" : [ ],
    "status" : "active",
    "project_id" : "087679f0aa80d32a2f4ec0172f5e902b",
    "enterprise_project_id" : "0",
    "tags" : [ ],
    "created_at" : "2020-06-15t06:29:40z",
    "updated_at" : "2020-06-15t06:29:41z",
    "cloud_resources" : [ {
      "resource_type" : "routetable",
      "resource_count" : 1
    }, {
      "resource_type" : "virsubnet",
      "resource_count" : 1
    } ]
  }, {
    "id" : "5ed053ba-b46c-4dce-a1ae-e9d8a7015f21",
    "name" : "api-perf-test-c34b1c4b12",
    "description" : "",
    "cidr" : "192.168.0.0/16",
    "extend_cidrs" : [ ],
    "status" : "active",
    "project_id" : "087679f0aa80d32a2f4ec0172f5e902b",
    "enterprise_project_id" : "0",
    "tags" : [ ],
    "created_at" : "2020-06-16t02:32:33z",
    "updated_at" : "2020-06-16t02:32:33z",
    "cloud_resources" : [ {
      "resource_type" : "routetable",
      "resource_count" : 1
    }, {
      "resource_type" : "virsubnet",
      "resource_count" : 0
    } ]
  } ],
  "page_info" : {
    "previous_marker" : "01da5a65-0bb9-4638-8ab7-74c64e24a9a7",
    "current_count" : 3
  }
}

状态码

状态码

描述

200

get操作正常返回，更多状态码请参见状态码。

错误码

请参见错误码。

父主题：

相关文档

网站地图