Contact UsGet started

Virtual Private Cloud API, REST: Address.Update

Written by
Updated at December 17, 2024

Updates the specified address.

HTTP request

PATCH https://vpc.api.cloud.yandex.net/vpc/v1/addresses/{addressId}

Path parameters

Field

Description

addressId

string

Required field. ID of the address to update.

To get the address ID make a AddressService.List request.

Body parameters

{
  "updateMask": "object",
  "name": "string",
  "description": "string",
  "labels": "object",
  "reserved": "boolean",
  "deletionProtection": "boolean",
  "dnsRecordSpecs": [
    {
      "fqdn": "string",
      "dnsZoneId": "string",
      "ttl": "string",
      "ptr": "boolean"
    }
  ]
}

Field

Description

updateMask

object (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

New name for the address.
The name must be unique within the folder.

description

string

New description of the address.

labels

object (map<string, string>)

Address labels as key:value pairs.

Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label:

  1. Get the current set of labels with a AddressService.Get request.
  2. Add or remove a label in this set.
  3. Send the new set in this field.

reserved

boolean

Specifies if address is reserved or not.

deletionProtection

boolean

Specifies if address protected from deletion.

dnsRecordSpecs[]

DnsRecordSpec

Optional DNS record specifications

DnsRecordSpec

Field

Description

fqdn

string

Required field. Required. DNS record name (absolute or relative to the DNS zone in use).

dnsZoneId

string

Required field. Required. ID of the public DNS zone. The maximum string length in characters is 20.

ttl

string (int64)

TTL of record. Acceptable values are 0 to 86400, inclusive.

ptr

boolean

Optional. If the PTR record is required, this parameter must be set to "true".

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "addressId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    // Includes only one of the fields `externalIpv4Address`
    "externalIpv4Address": {
      "address": "string",
      "zoneId": "string",
      "requirements": {
        "ddosProtectionProvider": "string",
        "outgoingSmtpCapability": "string"
      }
    },
    // end of the list of possible fields
    "reserved": "boolean",
    "used": "boolean",
    "type": "string",
    "ipVersion": "string",
    "deletionProtection": "boolean",
    "dnsRecords": [
      {
        "fqdn": "string",
        "dnsZoneId": "string",
        "ttl": "string",
        "ptr": "boolean"
      }
    ]
  }
  // 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.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

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

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

UpdateAddressMetadata

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

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

Address

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.

UpdateAddressMetadata

Field

Description

addressId

string

ID of the Address that is being updated.

Status

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

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Address

An Address resource. For more information, see Address.

Field

Description

id

string

ID of the address. Generated at creation time.

folderId

string

ID of the folder that the address belongs to.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the address.
The name is 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

Description of the address. 0-256 characters long.

labels

object (map<string, string>)

Address labels as 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]*.

externalIpv4Address

ExternalIpv4Address

Includes only one of the fields externalIpv4Address.

External ipv4 address specification.

reserved

boolean

Specifies if address is reserved or not.

used

boolean

Specifies if address is used or not.

type

enum (Type)

Type of the IP address.

  • TYPE_UNSPECIFIED
  • INTERNAL: Internal IP address.
  • EXTERNAL: Public IP address.

ipVersion

enum (IpVersion)

Version of the IP address.

  • IP_VERSION_UNSPECIFIED
  • IPV4: IPv4 address.
  • IPV6: IPv6 address.

deletionProtection

boolean

Specifies if address protected from deletion.

dnsRecords[]

DnsRecord

Optional DNS record specifications

ExternalIpv4Address

Field

Description

address

string

Value of address.

zoneId

string

Availability zone from which the address will be allocated.

requirements

AddressRequirements

Parameters of the allocated address, for example DDoS Protection.

AddressRequirements

Field

Description

ddosProtectionProvider

string

DDoS protection provider ID.

outgoingSmtpCapability

string

Capability to send SMTP traffic.

DnsRecord

Field

Description

fqdn

string

DNS record name (absolute or relative to the DNS zone in use).

dnsZoneId

string

ID of the public DNS zone.

ttl

string (int64)

TTL of record.

ptr

boolean

If the PTR record is required, this parameter must be set to "true".
Previous
Create
Next
Delete