Virtual Private Cloud API, REST: Address.List

Field

Description

folderId

string

Required field. ID of the folder to list addresses in.

To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListAddressesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListAddressesResponse.nextPageToken returned by a previous list request.

filter

string

A filter expression that filters Address listed in the response.

The expression must specify:

1. The field name. Currently you can use filtering only on Address.name field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
   Example of a filter: name=my-address.

Field

Description

addresses[]

Address

List of addresses.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListAddressesRequest.pageSize, use next_page_token as the value
for the ListAddressesRequest.pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

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

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.

Field

Description

ddosProtectionProvider

string

DDoS protection provider ID.

outgoingSmtpCapability

string

Capability to send SMTP traffic.

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".