Function
This API is used to create a VPC.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
| Action | Access Level | Resource Type (*: required) | Condition Key | Alias | Dependencies |
| vpc:vpcs:create | Write | vpc * | - | - | - |
| - | |
URI
POST /v1/{project_id}/vpcs
Table 1 describes the parameters.
Table 1 Parameter description | Parameter | 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 3 VPC objects | Parameter | 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.
- Range:
Recommended IP address ranges: - 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
In addition to the preceding IP address ranges, the value can be any IP address that can be routed publicly. However, the following IP address ranges reserved for the system and public network must be excluded: Reserved system IP address ranges - 100.64.0.0/10
- 214.0.0.0/7
- 198.18.0.0/15
- 169.254.0.0/16
Reserved public IP address ranges - 0.0.0.0/8
- 127.0.0.0/8
- 240.0.0.0/4
- 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.
|
| enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
|
| tags | No | Array of Strings | - Specifies VPC tags. When creating a VPC, you can add tags to the VPC.
- Each VPC can have up to 10 tags.
- key: Tag key. The key cannot be empty and can contain up to 128 characters (36 characters on the console). It can consist of letters, digits, underscores (_), and hyphens (-). Tag keys of a resource must be unique.
- value: Tag value. The value can contain up to 255 characters (43 characters on the console). It can consist of letters, digits, underscores (_), periods (.), and hyphens (-).
- Format: [key*value]. The key and value of each tag are connected by an asterisk (*).
|
| block_service_endpoint_states | No | String | - By default, resources in a VPC can access service endpoints over a private network. Enabling this function disables private network access. Cloud services, including SWR, LTS, HSS, AOM, APM, OBS, and API Gateway, cannot be accessed.
- Range:
- off: The function is disabled.
- on: The function is enabled.
|
| enable_network_address_usage_metrics | No | Boolean | - Definition: Whether to monitor the IPv4 address usage of all subnets in a VPC.
- Range:
- true: This function is enabled.
- false: This function is disabled.
|
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",
"enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2"
}
}
Response Parameters
Table 5 VPC objects | 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.
- Range:
Recommended IP address ranges: - 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
In addition to the preceding IP address ranges, the value can be any IP address that can be routed publicly. However, the following IP address ranges reserved for the system and public network must be excluded: Reserved system IP address ranges - 100.64.0.0/10
- 214.0.0.0/7
- 198.18.0.0/15
- 169.254.0.0/16
Reserved public IP address ranges - 0.0.0.0/8
- 127.0.0.0/8
- 240.0.0.0/4
- 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.
- Range:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
|
| routes | Array of route objects | - Specifies the route information.
- For details, see the description of the route objects.
|
| enterprise_project_id | String | - Specifies the enterprise project ID.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
|
| tenant_id | String | |
| created_at | String | - Specifies the time (UTC) when the VPC is created.
- Format: yyyy-MM-ddTHH:mm:ss
|
| updated_at | String | - Specifies the time (UTC) when the VPC is updated.
- Format: yyyy-MM-ddTHH:mm:ss
|
| block_service_endpoint_states | String | - By default, resources in a VPC can access service endpoints over a private network. Enabling this function disables private network access. Cloud services, including SWR, LTS, HSS, AOM, APM, OBS, and API Gateway, cannot be accessed.
- Range:
- off: The function is disabled.
- on: The function is enabled.
|
| enable_network_address_usage_metrics | Boolean | - Definition: Whether to monitor the IPv4 address usage of all subnets in a VPC.
- Range:
- true: This function is enabled.
- false: This function is disabled.
|
Table 6 route objects | Parameter | Type | Description |
| destination | String | - Specifies the destination CIDR block of a route.
- Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported.
|
| nexthop | String | - Specifies the next hop of a route.
- The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported.
|
Example Response
{
"vpc":
{
"id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
"name": "vpc",
"description": "test",
"cidr": "192.168.0.0/16",
"status": "CREATING",
"block_service_endpoint_states": "off",
"enable_network_address_usage_metrics": false,
"enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"routes": [],
"tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
"created_at": "2022-12-15T02:25:11",
"updated_at": "2022-12-15T02:25:11"
}
}