Virtual Private Cloud API, REST: Address.get
Returns the specified Address resource.
To get the list of all available Address resources, make a list request.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/addresses/{addressId}
Path parameters
Parameter | Description |
---|---|
addressId | Required. ID of the Address resource to return. To get Address resource ID make a list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"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"
}
}
}
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 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 |
description | string Description of the address. 0-256 characters long. |
labels | object Address labels as |
reserved | boolean (boolean) Specifies if address is reserved or not. |
used | boolean (boolean) Specifies if address is used or not. |
type | string Type of the IP address.
|
ipVersion | string Version of the IP address.
|
deletionProtection | boolean (boolean) Specifies if address protected from deletion. |
dnsRecords[] | object Optional DNS record specifications |
dnsRecords[]. fqdn |
string DNS record name (absolute or relative to the DNS zone in use). |
dnsRecords[]. dnsZoneId |
string ID of the public DNS zone. |
dnsRecords[]. ttl |
string (int64) TTL of record. |
dnsRecords[]. ptr |
boolean (boolean) If the PTR record is required, this parameter must be set to "true". |
externalIpv4Address | object |
externalIpv4Address. address |
string Value of address. |
externalIpv4Address. zoneId |
string Availability zone from which the address will be allocated. |
externalIpv4Address. requirements |
object Parameters of the allocated address, for example DDoS Protection. |
externalIpv4Address. requirements. ddosProtectionProvider |
string DDoS protection provider ID. |
externalIpv4Address. requirements. outgoingSmtpCapability |
string Capability to send SMTP traffic. |