Response Parameters for Querying VPCs

Response parameters are as follows.

Parameter description

Table 1 Response parameter

Parameter

Type

Description

vpcs

Array of vpcs objects

Specifies the VPCs.

Descriptions of vpcs fields

Table 2 vpcs field description

Parameter

Type

Description

id

String

Specifies a resource ID in UUID format.

name

String

  • Specifies the VPC name.

  • The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

  • Each VPC name of a tenant must be unique if the VPC name is not left blank.

description

String

  • Provides supplementary information about the VPC.

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

cidr

String

  • Specifies the available IP address ranges for subnets in the VPC.

  • Possible values are as follows:

    • 10.0.0.0/8-24

    • 172.16.0.0/12-24

    • 192.168.0.0/16-24

  • If cidr is not specified, the default value is left blank.

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

status

String

  • Specifies the VPC status.

  • Possible values are as follows:

    • CREATING: The VPC is being created.

    • OK: The VPC is created successfully.

routes

Array of route objects

  • Specifies the route information.

  • For details about constraints, see Table 3.

enable_shared_snat

Boolean

Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.

Description of the route field

Table 3 route objects

Name

Type

Description

destination

String

  • Specifies the destination network segment of a route.

  • The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.

nexthop

String

  • Specifies the next hop of a route.

  • The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.

Example response

{
 "vpc":
     {
     "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
     "name": "vpc",
     "description": "test",
     "cidr": "192.168.0.0/16",
     "status": "CREATING",
     "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
     "routes": []
     }
}
last updated: 2024-12-10 11:09 UTC - commit: e322c4c07d03a6da3ab444e54743326bf68e6163