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.
Name | Mandatory | Description |
---|---|---|
project_id | Yes | Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. |
Request Parameters¶
Name | Mandatory | Type | Description |
---|---|---|---|
name | No | String |
|
description | No | String |
|
cidr | No | String |
|
routes | No | Array of route objects |
|
enable_shared_snat | No | 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. |
Name | Mandatory | Type | Description |
---|---|---|---|
destination | No | String |
|
nexthop | No | String |
|
Example Request¶
Change the name, description, and CIDR block of the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3 to vpc1, test1, and 192.168.0.0/16, respectively.
PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 { "vpc": { "name": "vpc1", "description": "test1", "cidr": "192.168.0.0/16", "enable_shared_snat": true } }
Response Parameters¶
Name | Type | Description |
---|---|---|
id | String | Specifies a resource ID in UUID format. |
name | String | Specifies the VPC name. |
description | String |
|
cidr | String |
|
status | String |
|
routes | Array of route objects |
|
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. |
Name | Type | Description |
---|---|---|
destination | String |
|
nexthop | String |
|
Example Response¶
{
"vpc": {
"id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
"name": "vpc1",
"description": "test1",
"cidr": "192.168.0.0/16",
"status": "OK",
"routes": [],
"enable_shared_snat": true
}
}
Status Code¶
See Status Codes.
Error Code¶
See Error Codes.