Virtual Private Cloud API, REST: Address.GetByValue
Returns the specified Address resource by a given value.
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:byValue
Query parameters
|
Field |
Description |
|
externalIpv4Address |
string External ipv4 address specification. Includes only one of the fields Only one field must be specified. |
|
internalIpv4Address |
string Internal ipv4 address specification. Includes only one of the fields Only one field must be specified. |
|
subnetId |
string subnet where address was allocated Includes only one of the fields |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
// Includes only one of the fields `externalIpv4Address`, `internalIpv4Address`
"externalIpv4Address": {
"address": "string",
"zoneId": "string",
"requirements": {
"ddosProtectionProvider": "string",
"outgoingSmtpCapability": "string"
}
},
"internalIpv4Address": {
"address": "string",
// Includes only one of the fields `subnetId`
"subnetId": "string"
// end of the list of possible fields
},
// 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"
}
]
}
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 |
|
|
name |
string Name of the address. |
a-zA-Z?``. |
|
description |
string Description of the address. 0-256 characters long. |
|
|
labels |
object (map<string, string>) Address labels as |
|
|
externalIpv4Address |
External ipv4 address specification. Includes only one of the fields Only one field must be specified. |
|
|
internalIpv4Address |
Internal ipv4 address specification Includes only one of the fields Only one field must be specified. |
|
|
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.
|
|
|
ipVersion |
enum (IpVersion) Version of the IP address.
|
|
|
deletionProtection |
boolean Specifies if address protected from deletion. |
|
|
dnsRecords[] |
Optional DNS record specifications |
ExternalIpv4Address
|
Field |
Description |
|
address |
string Value of address. |
|
zoneId |
string Availability zone from which the address will be allocated. |
|
requirements |
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. |
InternalIpv4Address
|
Field |
Description |
|
address |
string Value of address. |
|
subnetId |
string Subnet from which the address will be allocated Includes only one of the fields Only one field must be specified. |
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". |