Virtual Private Cloud API, gRPC: AddressService.GetByValue
Returns the specified Address resource by a given value.
To get the list of all available Address resources, make a List request.
gRPC request
rpc GetByValue (GetAddressByValueRequest) returns (Address)
GetAddressByValueRequest
{
// Includes only one of the fields `external_ipv4_address`, `internal_ipv4_address`
"external_ipv4_address": "string",
"internal_ipv4_address": "string",
// end of the list of possible fields
// Includes only one of the fields `subnet_id`
"subnet_id": "string"
// end of the list of possible fields
}
|
Field |
Description |
|
external_ipv4_address |
string External ipv4 address specification. Includes only one of the fields Only one field must be specified. |
|
internal_ipv4_address |
string Internal ipv4 address specification. Includes only one of the fields Only one field must be specified. |
|
subnet_id |
string subnet where address was allocated Includes only one of the fields |
Address
{
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
// Includes only one of the fields `external_ipv4_address`, `internal_ipv4_address`
"external_ipv4_address": {
"address": "string",
"zone_id": "string",
"requirements": {
"ddos_protection_provider": "string",
"outgoing_smtp_capability": "string"
}
},
"internal_ipv4_address": {
"address": "string",
// Includes only one of the fields `subnet_id`
"subnet_id": "string"
// end of the list of possible fields
},
// end of the list of possible fields
"reserved": "bool",
"used": "bool",
"type": "Type",
"ip_version": "IpVersion",
"deletion_protection": "bool",
"dns_records": [
{
"fqdn": "string",
"dns_zone_id": "string",
"ttl": "int64",
"ptr": "bool"
}
]
}
An Address resource. For more information, see Address.
|
Field |
Description |
|
|
id |
string ID of the address. Generated at creation time. |
|
|
folder_id |
string ID of the folder that the address belongs to. |
|
|
created_at |
Creation timestamp. |
|
|
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 |
|
|
external_ipv4_address |
External ipv4 address specification. Includes only one of the fields Only one field must be specified. |
|
|
internal_ipv4_address |
Internal ipv4 address specification Includes only one of the fields Only one field must be specified. |
|
|
reserved |
bool Specifies if address is reserved or not. |
|
|
used |
bool Specifies if address is used or not. |
|
|
type |
enum Type Type of the IP address.
|
|
|
ip_version |
enum IpVersion Version of the IP address.
|
|
|
deletion_protection |
bool Specifies if address protected from deletion. |
|
|
dns_records[] |
Optional DNS record specifications |
ExternalIpv4Address
|
Field |
Description |
|
address |
string Value of address. |
|
zone_id |
string Availability zone from which the address will be allocated. |
|
requirements |
Parameters of the allocated address, for example DDoS Protection. |
AddressRequirements
|
Field |
Description |
|
ddos_protection_provider |
string DDoS protection provider ID. |
|
outgoing_smtp_capability |
string Capability to send SMTP traffic. |
InternalIpv4Address
|
Field |
Description |
|
address |
string Value of address. |
|
subnet_id |
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). |
|
dns_zone_id |
string ID of the public DNS zone. |
|
ttl |
int64 TTL of record. |
|
ptr |
bool If the PTR record is required, this parameter must be set to "true". |