Contact UsGet started

Virtual Private Cloud API, gRPC: SubnetService.Update

Written by
Updated at December 17, 2024

Updates the specified subnet.
Method starts an asynchronous operation that can be cancelled while it is in progress.

gRPC request

rpc Update (UpdateSubnetRequest) returns (operation.Operation)

UpdateSubnetRequest

{
  "subnet_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "route_table_id": "string",
  "dhcp_options": {
    "domain_name_servers": [
      "string"
    ],
    "domain_name": "string",
    "ntp_servers": [
      "string"
    ]
  },
  "v4_cidr_blocks": [
    "string"
  ]
}

Field

Description

subnet_id

string

Required field. ID of the Subnet resource to update.

update_mask

google.protobuf.FieldMask

Field mask that specifies which fields of the Subnet resource are going to be updated.

name

string

Name of the subnet.
The name must be unique within the folder.

description

string

Description of the subnet.

labels

object (map<string, string>)

Resource labels as key:value pairs.

route_table_id

string

ID of route table the subnet is linked to.

dhcp_options

DhcpOptions

v4_cidr_blocks[]

string

New CIDR blocks which will overwrite the existing ones.

DhcpOptions

Field

Description

domain_name_servers[]

string

A list of DHCP servers for this subnet.

domain_name

string

A domain name to us as a suffix when resolving host names in this subnet.

ntp_servers[]

string

List of NTP servers for this subnet.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "subnet_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "network_id": "string",
    "zone_id": "string",
    "v4_cidr_blocks": [
      "string"
    ],
    "v6_cidr_blocks": [
      "string"
    ],
    "route_table_id": "string",
    "dhcp_options": {
      "domain_name_servers": [
        "string"
      ],
      "domain_name": "string",
      "ntp_servers": [
        "string"
      ]
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateSubnetMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Subnet

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateSubnetMetadata

Field

Description

subnet_id

string

ID of the Subnet resource that is being updated.

Subnet

A Subnet resource. For more information, see Subnets.

Field

Description

id

string

ID of the subnet.

folder_id

string

ID of the folder that the subnet belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

name

string

Name of the subnet.
The name must be unique within the folder.
Value must match the regular expression \\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Optional description of the subnet. 0-256 characters long.

labels

object (map<string, string>)

Resource labels, key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_0-9a-z]*.

network_id

string

ID of the network the subnet belongs to.

zone_id

string

ID of the availability zone where the subnet resides.

v4_cidr_blocks[]

string

CIDR block.
The range of internal addresses that are defined for this subnet.
This field can be set only at Subnet resource creation time and cannot be changed.
For example, 10.0.0.0/22 or 192.168.0.0/24.
Minimum subnet size is /28, maximum subnet size is /16.

v6_cidr_blocks[]

string

IPv6 not available yet.

route_table_id

string

ID of route table the subnet is linked to.

dhcp_options

DhcpOptions

DHCP options for the subnet.

DhcpOptions

Field

Description

domain_name_servers[]

string

A list of DHCP servers for this subnet.

domain_name

string

A domain name to us as a suffix when resolving host names in this subnet.

ntp_servers[]

string

List of NTP servers for this subnet.
Previous
Create
Next
AddCidrBlocks