Updating a Subnet CIDR Reservation
Function
This API is used to update basic information about a subnet CIDR reservation, including the name and description.
Calling Method
For details, see Calling APIs.
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 Permissions Policies and Supported Actions for details on the required permissions.
- 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:subnets:updateReservation
Write
subnet *
-
g:ResourceTag/<tag-key>
-
vpc:VirsubnetCidrReservationId
-
g:EnterpriseProjectId
-
-
-
URI
PUT /v3/{project_id}/vpc/virsubnet-cidr-reservations/{virsubnet_cidr_reservation_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Range: N/A |
|
virsubnet_cidr_reservation_id |
Yes |
String |
Definition: ID of a subnet CIDR reservation. Range: N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
dry_run |
No |
Boolean |
Definition: Whether to only check the request. Constraints: N/A Range:
false |
|
virsubnet_cidr_reservation |
Yes |
Definition: Request body for updating a subnet CIDR reservation. Constraints: N/A Range: N/A Default Value: N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
Definition: Name of the subnet CIDR reservation. Constraints: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. Range: N/A Default Value: N/A |
|
description |
No |
String |
Definition: Description of a subnet CIDR reservation. Constraints: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). Range: N/A Default Value: N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
Definition: Request ID. Range: N/A |
|
virsubnet_cidr_reservation |
VirsubnetCidrReservation object |
Definition: Response body for updating a subnet CIDR reservation. Range: N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Definition: ID of a subnet CIDR reservation. Each subnet CIDR reservation comes with an ID, which uniquely identifies the subnet CIDR reservation. Range: The value is in UUID format with hyphens (-). |
|
virsubnet_id |
String |
Definition: ID of the subnet that a subnet CIDR reservation belongs to. Range: The value is in UUID format with hyphens (-). |
|
vpc_id |
String |
Definition: ID of the VPC that a subnet CIDR reservation belongs to. Range: The value is in UUID format with hyphens (-). |
|
ip_version |
Integer |
Definition: IP address version of a subnet CIDR reservation. Range:
|
|
cidr |
String |
Definition: CIDR block of a subnet CIDR reservation. Range: The value is in CIDR block format. The minimum netmask value is the subnet netmask value plus 2, and the maximum netmask value is 32 (IPv4) or 128 (IPv6). |
|
name |
String |
Definition: Name of the subnet CIDR reservation. Range: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. |
|
description |
String |
Definition: Description of a subnet CIDR reservation. Range: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). |
|
project_id |
String |
Definition: ID of the project that a subnet CIDR reservation belongs to. Range: N/A |
|
created_at |
String |
Definition: Time when a subnet CIDR reservation is created. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. |
|
updated_at |
String |
Definition: Time when the subnet CIDR reservation was last updated. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. |
Example Requests
Update name and description of the subnet CIDR reservation whose ID is ed4edb94-754c-7848-bb77-2d381906c535 to name-test-updated and description-test-updated.
PUT https://{Endpoint}/v3/{project_id}/vpc/virsubnet-cidr-reservations/ed4edb94-754c-7848-bb77-2d381906c535
{
"virsubnet_cidr_reservation" : {
"name" : "name-test-updated",
"description" : "description-test-updated"
}
}
Example Responses
Status code: 200
The PUT operation is successful. For more status codes, see Status Codes.
{
"virsubnet_cidr_reservation" : {
"id" : "ed4edb94-754c-7848-bb77-2d381906c535",
"virsubnet_id" : "fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19",
"vpc_id" : "cef5d621-6c20-d5df-74e8-746271fba734",
"ip_version" : 4,
"cidr" : "192.168.21.96/28",
"name" : "name-test-updated",
"description" : "description-test-updated",
"project_id" : "11e8dd119c77479db890e266e68c1ecf",
"created_at" : "2024-09-09T11:56:27Z",
"updated_at" : "2024-09-09T12:00:06Z"
},
"request_id" : "5e8c57bcfa0bd4798915cb5d7a37c1d9"
}
SDK Sample Code
The SDK sample code is as follows.
Update name and description of the subnet CIDR reservation whose ID is ed4edb94-754c-7848-bb77-2d381906c535 to name-test-updated and description-test-updated.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; public class UpdateVirsubnetCidrReservationSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); UpdateVirsubnetCidrReservationRequest request = new UpdateVirsubnetCidrReservationRequest(); request.withVirsubnetCidrReservationId("{virsubnet_cidr_reservation_id}"); UpdateVirsubnetCidrReservationRequestBody body = new UpdateVirsubnetCidrReservationRequestBody(); UpdateVirsubnetCidrReservationOption virsubnetCidrReservationbody = new UpdateVirsubnetCidrReservationOption(); virsubnetCidrReservationbody.withName("name-test-updated") .withDescription("description-test-updated"); body.withVirsubnetCidrReservation(virsubnetCidrReservationbody); request.withBody(body); try { UpdateVirsubnetCidrReservationResponse response = client.updateVirsubnetCidrReservation(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Update name and description of the subnet CIDR reservation whose ID is ed4edb94-754c-7848-bb77-2d381906c535 to name-test-updated and description-test-updated.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateVirsubnetCidrReservationRequest() request.virsubnet_cidr_reservation_id = "{virsubnet_cidr_reservation_id}" virsubnetCidrReservationbody = UpdateVirsubnetCidrReservationOption( name="name-test-updated", description="description-test-updated" ) request.body = UpdateVirsubnetCidrReservationRequestBody( virsubnet_cidr_reservation=virsubnetCidrReservationbody ) response = client.update_virsubnet_cidr_reservation(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Update name and description of the subnet CIDR reservation whose ID is ed4edb94-754c-7848-bb77-2d381906c535 to name-test-updated and description-test-updated.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := vpc.NewVpcClient( vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateVirsubnetCidrReservationRequest{} request.VirsubnetCidrReservationId = "{virsubnet_cidr_reservation_id}" nameVirsubnetCidrReservation:= "name-test-updated" descriptionVirsubnetCidrReservation:= "description-test-updated" virsubnetCidrReservationbody := &model.UpdateVirsubnetCidrReservationOption{ Name: &nameVirsubnetCidrReservation, Description: &descriptionVirsubnetCidrReservation, } request.Body = &model.UpdateVirsubnetCidrReservationRequestBody{ VirsubnetCidrReservation: virsubnetCidrReservationbody, } response, err := client.UpdateVirsubnetCidrReservation(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The PUT operation is successful. For more status codes, see Status Codes. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot