Updating a Subnet CIDR Reservation

Function

This API is used to update a subnet CIDR reservation.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/vpc/virsubnet-cidr-reservations/{virsubnet_cidr_reservation_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
virsubnet_cidr_reservation_id	Yes	String	ID of a subnet CIDR reservation.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
dry_run	No	Boolean	Whether to only send the check request. The value can be: true: Only the check request will be sent and no subnet CIDR reservation will be updated. Check items include mandatory parameters, request format, and constraints. If the check fails, the system returns an error. If the check succeeds, response code 202 will be returned. false (default value): A request will be sent and a subnet CIDR reservation will be updated.
virsubnet_cidr_reservation	Yes	UpdateVirsubnetCidrReservationOption object	Request body for updating a subnet CIDR reservation.

**Table 3** UpdateVirsubnetCidrReservationOption
Parameter	Mandatory	Type	Description
name	No	String	Name of a subnet CIDR reservation. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	No	String	Description of a subnet CIDR reservation. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Request ID.
virsubnet_cidr_reservation	VirsubnetCidrReservation object	Response body for updating a subnet CIDR reservation.

**Table 5** VirsubnetCidrReservation
Parameter	Type	Description
id	String	Unique ID of a subnet CIDR reservation. The value is in UUID format with hyphens (-).
virsubnet_id	String	ID of the virtual subnet that a subnet CIDR reservation belongs to. The value is in UUID format with hyphens (-).
vpc_id	String	ID of the VPC that a subnet CIDR reservation belongs to. The value is in UUID format with hyphens (-).
ip_version	Integer	IP version of a subnet CIDR reservation. The value can be: 4: IPv4 6: IPv6
cidr	String	Subnet CIDR reservation. 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	Name of a subnet CIDR reservation. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Description of a subnet CIDR reservation. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
project_id	String	ID of the project that a subnet CIDR reservation belongs to.
created_at	String	The time when a subnet CIDR reservation is created. UTC time in the format of yyyy-MM-ddTHH:mm:ssZ
updated_at	String	The time when a subnet CIDR reservation is updated. 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"
}