Virtual Private Cloud API, gRPC: AddressService.Create
Creates an address in the specified folder and network.
gRPC request
rpc Create (CreateAddressRequest) returns (operation.Operation)
CreateAddressRequest
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "string",
// Includes only one of the fields `externalIpv4AddressSpec`
"externalIpv4AddressSpec": {
"address": "string",
"zoneId": "string",
"requirements": {
"ddosProtectionProvider": "string",
"outgoingSmtpCapability": "string"
}
},
// end of the list of possible fields
"deletionProtection": "bool",
"dnsRecordSpecs": [
{
"fqdn": "string",
"dnsZoneId": "string",
"ttl": "int64",
"ptr": "bool"
}
]
}
Field |
Description |
folderId |
string Required field. ID of the folder to create a address in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
name |
string Name of the address. |
description |
string Description of the address. |
labels |
string Address labels as |
externalIpv4AddressSpec |
Includes only one of the fields External ipv4 address specification. |
deletionProtection |
bool Specifies if address protected from deletion. |
dnsRecordSpecs[] |
Optional DNS record specifications |
ExternalIpv4AddressSpec
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. |
DnsRecordSpec
Field |
Description |
fqdn |
string Required field. Required. DNS record name (absolute or relative to the DNS zone in use). |
dnsZoneId |
string Required field. Required. ID of the public DNS zone. The maximum string length in characters is 20. |
ttl |
int64 TTL of record. Acceptable values are 0 to 86400, inclusive. |
ptr |
bool Optional. If the PTR record is required, this parameter must be set to "true". |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"addressId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
// Includes only one of the fields `externalIpv4Address`
"externalIpv4Address": {
"address": "string",
"zoneId": "string",
"requirements": {
"ddosProtectionProvider": "string",
"outgoingSmtpCapability": "string"
}
},
// end of the list of possible fields
"reserved": "bool",
"used": "bool",
"type": "Type",
"ipVersion": "IpVersion",
"deletionProtection": "bool",
"dnsRecords": [
{
"fqdn": "string",
"dnsZoneId": "string",
"ttl": "int64",
"ptr": "bool"
}
]
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateAddressMetadata
Field |
Description |
addressId |
string ID of the address that is being created. |
Address
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 |
Creation timestamp. |
name |
string Name of the address. |
description |
string Description of the address. 0-256 characters long. |
labels |
string Address labels as |
externalIpv4Address |
Includes only one of the fields External ipv4 address specification. |
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.
|
ipVersion |
enum IpVersion Version of the IP address.
|
deletionProtection |
bool 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. |
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 |
int64 TTL of record. |
ptr |
bool If the PTR record is required, this parameter must be set to "true". |