Skip to main content

types

Address​

An Address resource. For more information, see Address.

Type​

  • TYPE_UNSPECIFIED

  • INTERNAL

    Internal IP address.

  • EXTERNAL

    Public IP address.

IpVersion​

  • IP_VERSION_UNSPECIFIED

  • IPV4

    IPv4 address.

  • IPV6

    IPv6 address.

id : string​

ID of the address. Generated at creation time.

folderId : string​

ID of the folder that the address belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the address. The name is unique within the folder. Value must match the regular expression \|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description : string​

Description of the address. 0-256 characters long.

labels : string​

Address labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

One of address​

External ipv4 address specification.

  • externalIpv4Address : ExternalIpv4Address​
reserved : bool​

Specifies if address is reserved or not.

used : bool​

Specifies if address is used or not.

type : Type​

Type of the IP address.

ipVersion : IpVersion​

Version of the IP address.

deletionProtection : bool​

Specifies if address protected from deletion.

dnsRecords : DnsRecord​

Optional DNS record specifications

AddressRequirements​

ddosProtectionProvider : string​

DDoS protection provider ID.

outgoingSmtpCapability : string​

Capability to send SMTP traffic.

CidrBlocks​

v4CidrBlocks : string​

IPv4 CIDR blocks to allow traffic to.

v6CidrBlocks : string​

IPv6 CIDR blocks to allow traffic to.

DhcpOptions​

domainNameServers : string​

A list of DHCP servers for this subnet.

domainName : string​

A domain name to us as a suffix when resolving host names in this subnet.

ntpServers : string​

List of NTP servers for this subnet.

DnsRecord​

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".

ExternalIpv4Address​

address : string​

Value of address.

zoneId : string​

Availability zone from which the address will be allocated.

requirements : AddressRequirements​

Parameters of the allocated address, for example DDoS Protection.

Gateway​

A Gateway resource. For more information, see Gateway.

id : string​

ID of the gateway. Generated at creation time.

folderId : string​

ID of the folder that the gateway belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the gateway. The name is unique within the folder. Value must match the regular expression \|[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description : string​

Description of the gateway. 0-256 characters long.

labels : string​

Gateway labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.

One of gateway​

Gateway specification

  • sharedEgressGateway : SharedEgressGateway​

Network​

A Network resource. For more information, see Networks.

id : string​

ID of the network.

folderId : string​

ID of the folder that the network belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the network. The name is unique within the folder. Value must match the regular expression \|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description : string​

Optional description of the network. 0-256 characters long.

labels : string​

Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

defaultSecurityGroupId : string​

ID of default security group for network.

PortRange​

fromPort : int64​

The lowest port in the range.

toPort : int64​

The highest port in the range.

RouteTable​

A RouteTable resource. For more information, see Static Routes.

id : string​

ID of the route table.

folderId : string​

ID of the folder that the route table belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the route table. The name must be unique within the folder. Value must match the regular expression |[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description : string​

Optional description of the route table. 0-256 characters long.

labels : string​

Resource labels, key:value pairs. No more than 64 per resource. The string length in characters for each key must be 1-63. Each value must match the regular expression [-_0-9a-z]*. Each key must match the regular expression [a-z][-_0-9a-z]*.

networkId : string​

ID of the network the route table belongs to.

staticRoutes : StaticRoute​

List of static routes.

SecurityGroup​

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    Security group is being created.

  • ACTIVE

    Security is active and it's rules are applied to the network interfaces.

  • UPDATING

    Security group is updating. Updating is a long operation because we must update all instances in SG.

  • DELETING

    Instance is being deleted.

id : string​

ID of the security group.

folderId : string​

ID of the folder that the security group belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the security group. The name must be unique within the folder. Value must match the regular expression \|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description : string​

Description of the security group. 0-256 characters long.

labels : string​

Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.

networkId : string​

ID of the network that the security group belongs to.

status : Status​

Security group status.

rules : SecurityGroupRule​

List of the security group rules.

defaultForNetwork : bool​

Flag that indicates that the security group is the default for the network.

SecurityGroupRule​

Direction​

  • DIRECTION_UNSPECIFIED

  • INGRESS

    Allows ingress traffic.

  • EGRESS

    Allows egress traffic.

id : string​

ID of the rule.

description : string​

Description of the rule. 0-256 characters long.

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.

direction : Direction​

The direction of network traffic allowed by this rule.

ports : PortRange​

The range of ports that allow traffic to pass through. Null value means any.

protocolName : string​

Protocol name. Null value means any protocol. Values from IANA.

protocolNumber : int64​

Protocol number from IANA protocol numbers.

One of target​

  • cidrBlocks : CidrBlocks​

    CIDR blocks to allow to recieve or send traffic.

  • securityGroupId : string​

    ID of the security group to add rule to.

  • predefinedTarget : string​

    Predefined target. See security groups rules for more information.

SharedEgressGateway​

Shared Egress Gateway configuration

StaticRoute​

A StaticRoute resource. For more information, see Static Routes.

One of destination​

  • destinationPrefix : string​

    Destination subnet in CIDR notation

One of nextHop​

  • nextHopAddress : string​

    Next hop IP address

  • gatewayId : string​

    Next hop gateway id

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.

Subnet​

A Subnet resource. For more information, see Subnets.

id : string​

ID of the subnet.

folderId : string​

ID of the folder that the subnet belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the subnet. The name must be unique within the folder. Value must match the regular expression \|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description : string​

Optional description of the subnet. 0-256 characters long.

labels : string​

Resource labels, key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

networkId : string​

ID of the network the subnet belongs to.

zoneId : string​

ID of the availability zone where the subnet resides.

v4CidrBlocks : string​

CIDR block. The range of internal addresses that are defined for this subnet. This field can be set only at Subnet resource creation time and cannot be changed. For example, 10.0.0.0/22 or 192.168.0.0/24. Minimum subnet size is /28, maximum subnet size is /16.

v6CidrBlocks : string​

IPv6 not available yet.

routeTableId : string​

ID of route table the subnet is linked to.

dhcpOptions : DhcpOptions​

DHCP options for the subnet.