Virtual Private Cloud API, REST: Address.list
Retrieves the list of Address resources in the specified folder.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/addresses
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list addresses in. To get the folder ID use a list request. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
filter | A filter expression that filters Address listed in the response. The expression must specify:
|
Response
HTTP Code: 200 - OK
{
"addresses": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"reserved": true,
"used": true,
"type": "string",
"ipVersion": "string",
"deletionProtection": true,
"dnsRecords": [
{
"fqdn": "string",
"dnsZoneId": "string",
"ttl": "string",
"ptr": true
}
],
"externalIpv4Address": {
"address": "string",
"zoneId": "string",
"requirements": {
"ddosProtectionProvider": "string",
"outgoingSmtpCapability": "string"
}
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
addresses[] | object List of addresses. |
addresses[]. id |
string ID of the address. Generated at creation time. |
addresses[]. folderId |
string ID of the folder that the address belongs to. |
addresses[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from 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). |
addresses[]. name |
string Name of the address. The name is unique within the folder. |
addresses[]. description |
string Description of the address. |
addresses[]. labels |
object Resource labels as |
addresses[]. reserved |
boolean (boolean) Specifies if address is reserved or not. |
addresses[]. used |
boolean (boolean) Specifies if address is used or not. |
addresses[]. type |
string Type of the IP address.
|
addresses[]. ipVersion |
string Version of the IP address.
|
addresses[]. deletionProtection |
boolean (boolean) Specifies if address protected from deletion. |
addresses[]. dnsRecords[] |
object Optional dns record specifications |
addresses[]. dnsRecords[]. fqdn |
string |
addresses[]. dnsRecords[]. dnsZoneId |
string |
addresses[]. dnsRecords[]. ttl |
string (int64) |
addresses[]. dnsRecords[]. ptr |
boolean (boolean) |
addresses[]. externalIpv4Address |
object |
addresses[]. externalIpv4Address. address |
string Value of address. |
addresses[]. externalIpv4Address. zoneId |
string Availability zone from which the address will be allocated. |
addresses[]. externalIpv4Address. requirements |
object Parameters of the allocated address, for example DDoS Protection. |
addresses[]. externalIpv4Address. requirements. ddosProtectionProvider |
string DDoS protection provider ID. |
addresses[]. externalIpv4Address. requirements. outgoingSmtpCapability |
string Capability to send SMTP traffic. |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |