Updating VPC Information

Function

This API is used to update information about a VPC.

URI

PUT /v1/{project_id}/vpcs/{vpc_id}

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID.
vpc_id	Yes	Specifies the VPC ID, which uniquely identifies the VPC.

Request Message

Request parameter

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

**Table 3** VPC objects
Name	Mandatory	Type	Description
name	No	String	Specifies the VPC name. The value is a string of no more than 64 characters that can contain 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 is a string of 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.
routes	No	Array of route objects	Specifies the route list. For details, see Table 7.

**Table 4** **route** objects
Name	Mandatory	Type	Description
destination	No	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	No	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 request

PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3

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

Response Message

Response parameter

**Table 5** Response parameter
Name	Type	Description
vpc	Object	Specifies the VPC objects.

**Table 6** VPC objects
Name	Type	Description
id	String	Specifies a resource ID in UUID format.
name	String	Specifies the VPC name.
description	String	Provides supplementary information about the VPC. The value is a string of 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, see the description of the route objects.

**Table 7** **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": "vpc1",
        "description": "test1",
        "cidr": "192.168.0.0/16",
        "status": "OK"
        
    }
}