Querying VPCs

project_id

Yes

String

• Definition: ID of the project that a VPC belongs to. For details about how to obtain a project ID, see Obtaining a Project ID.

• Range: None

limit

No

Integer

• Definition: Number of records returned on each page.

• Range: 0-2000

marker

No

String

• Definition: ID of the resource from which the pagination query starts. If the parameter is left blank, only resources on the first page are queried.

• Range: VPC ID.

id

No

Array of strings

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

• Range: None

name

No

Array of strings

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

• Range: None

description

No

Array of strings

• Definition: VPC description, which can be used to filter VPCs.

• Range: None

cidr

No

Array of strings

• Definition: CIDR block of a VPC, which can be used to filter VPCs.

• Range: None

request_id

String

• Definition: Request ID.

• Range: None

vpcs

Array of Vpc objects

• Definition: Response body for querying VPCs.

• Range: None

page_info

PageInfo object

• Definition: Pagination information.

• Range: None

id

String

• Definition: VPC ID. After a VPC is created, a VPC ID is generated, which uniquely identifies the VPC.

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

name

String

• Definition: VPC name.

• Range: The value can contain 0 to 64 characters. It can include letters, digits, underscores (_), hyphens (-), and periods (.).

description

String

• Definition: Description of a VPC.

• Range: The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

cidr

String

• Definition: Available subnets in a VPC.

• Range:

  • 10.0.0.0/8–24: The IP address ranges from 10.0.0.0 to 10.255.255.255, and the netmask ranges from 8 to 24.

  • 172.16.0.0/12–24: The IP address ranges from 172.16.0.0 to 172.31.255.255, and the netmask ranges from 12 to 24.

  • 192.168.0.0/16–24: The IP address ranges from 192.168.0.0 to 192.168.255.255, and the netmask ranges from 16 to 24.

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

extend_cidrs

Array of strings

• Definition: Secondary CIDR blocks of a VPC.

• Range: The following CIDR blocks are not supported:

  • 10.0.0.0/8: The IP address range is 10.0.0.0-10.255.255.255.

  • 172.16.0.0/12: The IP address range is 172.16.0.0-172.31.255.255.

  • 192.168.0.0/16: The IP address range is 192.168.0.0-192.168.255.255.

  • 172.31.0.0/16: The IP address range is 172.31.0.0-172.31.255.255.

  • 100.64.0.0/10: The IP address range is 100.64.0.0-100.127.255.255.

  • 214.0.0.0/7: The IP address range is 214.0.0.0-215.255.255.255.

  • 198.18.0.0/15: The IP address range is 198.18.0.0-198.19.255.255.

  • 169.254.0.0/16: The IP address range is 169.254.0.0-169.254.255.255.

  • 0.0.0.0/8: The IP address range is 0.0.0.0-0.255.255.255.

  • 127.0.0.0/8: The IP address range is 127.0.0.0-127.255.255.255.

  • 240.0.0.0/4: The IP address range is 240.0.0.0-255.255.255.255.

status

String

• Definition: VPC status.

• Range:

  • PENDING: The VPC is being created.

  • ACTIVE: The VPC is created.

project_id

String

• Definition: ID of the project that a VPC belongs to.

• Range: None

enterprise_project_id

String

• Definition: ID of the enterprise project that a VPC belongs to.

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

created_at

String

• Definition: Time when a VPC was created.

• Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ

updated_at

String

• Definition: Time when a VPC was updated.

• Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ

cloud_resources

Array of CloudResource objects

• Definition: Type and number of resources associated with a VPC. For example, subnets and route tables.

• Range: None

tags

Array of ResponseTag objects

• Definition: Tags of a VPC, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.

• Range: None

resource_type

String

• Definition: Resource type.

• Range: None

resource_count

Integer

• Definition: Number of resources.

• Range: None

key

String

Definition:

Tag key.

Range:

• A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.

• Each tag key of a resource must be unique.

• The value can contain:

  • Letters

  • Digits

  • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

  • Chinese characters

value

String

Definition:

Tag value.

Range:

• Each value can contain a maximum of 255 Unicode characters and can be left blank.

• The value can contain:

  • Letters

  • Digits

  • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

  • Chinese characters

previous_marker

String

Definition:

The first record on the current page.

Range:

N/A

current_count

Integer

Definition:

Total number of resources on the current page.

Range:

N/A

next_marker

String

Definition:

The last record on the current page. The next_marker field does not exist if the page is the last one.

Range:

N/A

200

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