Querying VPCs

project_id

Yes

String

Project ID.

For details about how to obtain a project ID, see Obtaining a Project ID.

limit

No

Integer

• Number of records returned on each page.

• Value range: 0 to 2000.

marker

No

String

• Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

id

No

Array of strings

• VPC ID, which can be used to filter VPCs.

name

No

Array of strings

• VPC name, which can be used to filter VPCs.

description

No

Array of strings

• Supplementary information about the VPC, which can be used to filter VPCs.

cidr

No

Array of strings

• VPC CIDR block, which can be used to filter VPCs.

request_id

String

Request ID.

vpcs

Array of Vpc objects

Response body for querying VPCs.

page_info

PageInfo object

Pagination information.

id

String

• VPC ID, which uniquely identifies the VPC.

• The value is in UUID format with hyphens (-).

name

String

• VPC name.

• The name can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

description

String

• Supplementary information about the VPC.

• The value can contain up to 255 characters and cannot contain angle brackets (< or >).

cidr

String

• Available VPC CIDR blocks.

• The value can be:

  • 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

  • If cidr is not specified, the default value is "".

• The value must be in IPv4 CIDR format, for example, 192.168.0.0/16.

extend_cidrs

Array of strings

• Secondary CIDR blocks of a VPC.

• Currently, only IPv4 CIDR blocks are supported.

status

String

• VPC status.

• The value can be:

  • PENDING: The VPC is being created.

  • ACTIVE: The VPC is created successfully.

project_id

String

• ID of the project to which the VPC belongs.

enterprise_project_id

String

• ID of the enterprise project to which the VPC belongs.

• The value can be 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.

created_at

String

• Time when the VPC is created.

• The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

updated_at

String

• Time when the VPC is updated.

• The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

cloud_resources

Array of CloudResource objects

• Type and number of resources associated with the VPC.

• Currently, only route tables and subnets of the VPC are returned. The number of virsubnets is the total number of IPv4 and IPv6 subnets.

tags

Array of Tag objects

• VPC tags. For details, see the tag objects.

• Value range: 0 to 20 tag key-value pairs.

resource_type

String

• Resource type.

resource_count

Integer

• Number of resources.

Default: 0

key

String

• Tag key.

• Value ranges:

  • Each key can contain up to 36 Unicode characters and cannot be left blank.

  • Each key value of a resource must be unique.

  • The value can contain:

    • Letters

    • Digits

    • Special characters: underscores (_), and hyphens (-)

    • Chinese characters

value

String

• Tag value.

• Value range:

  • Each value can contain up to 43 Unicode characters and can be left blank.

  • The value can contain:

    • Letters

    • Digits

    • Special characters: underscore (_), dot (.), and hyphen (-)

    • Chinese characters

previous_marker

String

First record on the current page.

current_count

Integer

Total number of records on the current page.

next_marker

String

Last record on the current page. This parameter does not exist if the page is the last one.

200

Normal response for the GET operation. For more status codes, see Status Code.