Creating a VPC

Function

This API is used to create a VPC.

URI

POST /v1/{project_id}/vpcs

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request parameter
Name	Mandatory	Type	Description
vpc	Yes	vpc object	Specifies the VPC objects.

**Table 3** VPC objects
Name	Mandatory	Type	Description
name	No	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	No	String	Provides supplementary information about the VPC. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
cidr	No	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.

Example Request

Create a VPC named vpc and set its CIDR block to 192.168.0.0/16.

POST https://{Endpoint}/v1/{project_id}/vpcs

{
    "vpc": {
        "name": "vpc",
        "description": "test",
        "cidr": "192.168.0.0/16"
    }
}

Response Parameters

**Table 4** Response parameter
Name	Type	Description
vpc	vpc object	Specifies the VPC objects.

**Table 5** VPC objects
Name	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.

Example Response

{
 "vpc": 
     {
     "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
     "name": "vpc",
     "description": "test",
     "cidr": "192.168.0.0/16",
     "status": "CREATING",
     }
}