Skip to main content

types

AttachedDisk​

Mode​

  • MODE_UNSPECIFIED

  • READ_ONLY

    Read-only access.

  • READ_WRITE

    Read/Write access.

mode : Mode​

Access mode to the Disk resource.

deviceName : string​

Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance.

This value can be used to reference the device for mounting, resizing, and so on, from within the instance.

autoDelete : bool​

Specifies whether the disk will be auto-deleted when the instance is deleted.

diskId : string​

ID of the disk that is attached to the instance.

AttachedFilesystem​

Mode​

  • MODE_UNSPECIFIED

  • READ_ONLY

    Read-only access.

  • READ_WRITE

    Read/Write access.

mode : Mode​

Access mode to the filesystem.

deviceName : string​

Name of the device representing the filesystem on the instance.

The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc.

filesystemId : string​

ID of the filesystem that is attached to the instance.

AttachedLocalDisk​

size : int64​

Size of the disk, specified in bytes.

deviceName : string​

Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance.

This value can be used to reference the device for mounting, resizing, and so on, from within the instance.

Disk​

A Disk resource. For more information, see Disks.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    Disk is being created.

  • READY

    Disk is ready to use.

  • ERROR

    Disk encountered a problem and cannot operate.

  • DELETING

    Disk is being deleted.

id : string​

ID of the disk.

folderId : string​

ID of the folder that the disk belongs to.

createdAt : google.protobuf.Timestamp​
name : string​

Name of the disk. 1-63 characters long.

description : string​

Description of the disk. 0-256 characters long.

labels : string​

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

typeId : string​

ID of the disk type.

zoneId : string​

ID of the availability zone where the disk resides.

size : int64​

Size of the disk, specified in bytes.

blockSize : int64​

Block size of the disk, specified in bytes.

productIds : string​

License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.

The correct license ID is generated by the platform. IDs are inherited by new resources created from this resource.

If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.

status : Status​

Current status of the disk.

One of source​

  • sourceImageId : string​

    ID of the image that was used for disk creation.

  • sourceSnapshotId : string​

    ID of the snapshot that was used for disk creation.

instanceIds : string​

Array of instances to which the disk is attached.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration.

hardwareGeneration : HardwareGeneration​

If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used.

kmsKey : KMSKey​

Key encryption key info.

DiskPartitionPlacementStrategy​

partitions : int64​

DiskPlacementGroup​

Status​

  • STATUS_UNSPECIFIED

  • CREATING

  • READY

  • DELETING

id : string​

ID of the placement group.

folderId : string​

ID of the folder that the placement group belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the placement group. The name is unique within the folder.

description : string​

Description of the placement group.

labels : string​

Resource labels as key:value pairs.

zoneId : string​

ID of the availability zone where the placement group resides.

status : Status​

Current status of the placement group

One of placementStrategy​

Placement strategy.

  • spreadPlacementStrategy : DiskSpreadPlacementStrategy​

    Distribute disks over distinct failure domains.

  • partitionPlacementStrategy : DiskPartitionPlacementStrategy​

    Distribute disks over partitions.

DiskPlacementPolicy​

placementGroupId : string​

Placement group ID.

placementGroupPartition : int64​

DiskPlacementPolicyChange​

diskId : string​

Disk ID.

diskPlacementPolicy : DiskPlacementPolicy​

Placement policy configuration for given disk.

DiskSpreadPlacementStrategy​

DiskType​

id : string​

ID of the disk type.

description : string​

Description of the disk type. 0-256 characters long.

zoneIds : string​

Array of availability zones where the disk type is available.

DnsRecord​

fqdn : string​

Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).

dnsZoneId : string​

DNS zone id for the record (optional, if not set, some private zone is used).

ttl : int64​

DNS record ttl (optional, if not set, a reasonable default is used.)

ptr : bool​

When true, indicates there is a corresponding auto-created PTR DNS record.

Filesystem​

A filesystem resource. For details about the concept, see documentation.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    The filesystem is being created.

  • READY

    The filesystem is ready to use.

  • ERROR

    The filesystem encountered a problem and cannot operate.

  • DELETING

    The filesystem is being deleted.

id : string​

ID of the filesystem. Generated at creation time.

folderId : string​

ID of the folder that the filesystem belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the filesystem. The name is unique within the folder.

description : string​

Description of the filesystem.

labels : string​

Filesystem labels as key:value pairs. For details about the concept, see documentation.

typeId : string​

ID of the filesystem type.

To get a list of available filesystem types, make a yandex.cloud.compute.v1.DiskTypeService.List request.

zoneId : string​

ID of the availability zone where the filesystem resides.

A filesystem can be attached only to instances residing in the same availability zone.

size : int64​

Size of the filesystem, specified in bytes.

blockSize : int64​

Block size used for the filesystem, specified in bytes.

status : Status​

Current status of the filesystem.

Generation2HardwareFeatures​

A second hardware generation, which by default assumes PCI_TOPOLOGY_V2 and UEFI boot (with UEFI related features).

GpuCluster​

A GPU cluster. For details about the concept, see documentation.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    GPU cluster is being created.

  • READY

    GPU cluster is ready to use.

  • ERROR

    GPU cluster encountered a problem and cannot operate.

  • DELETING

    GPU cluster is being deleted.

id : string​

ID of GPU cluster.

folderId : string​

ID of the folder that the GPU cluster belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the GPU cluster.

The name is unique within the folder.

description : string​

Description of the GPU cluster.

labels : string​

GPU cluster labels as key:value pairs.

status : Status​

Status of the GPU cluster.

zoneId : string​

ID of the availability zone where the GPU cluster resides.

interconnectType : GpuInterconnectType​

Type of interconnect used for this GPU cluster.

GpuSettings​

gpuClusterId : string​

Attach instance to specified GPU cluster.

HardwareGeneration​

A set of features, specific to a particular Compute hardware generation. They are not necessary supported by every host OS or distro, thus they are fixed to an image and are applied to all instances created with it as their boot disk image. These features significantly determine how the instance is created, thus cannot be changed after the fact.

One of features​

  • legacyFeatures : LegacyHardwareFeatures​
  • generation2Features : Generation2HardwareFeatures​

Host​

Represents a dedicated host

Status​

  • STATUS_UNSPECIFIED

  • UP

  • DOWN

id : string​

ID of the host.

status : Status​

Current status of the host. New instances are unable to start on host in DOWN status.

serverId : string​

ID of the physical server that the host belongs to.

replacement : Replacement​

Set temporarily if maintenance is planned for this host, and a new host was provided as a replacement.

HostGroup​

Represents group of dedicated hosts

Status​

  • STATUS_UNSPECIFIED

  • CREATING

  • READY

  • UPDATING

  • DELETING

id : string​

ID of the group.

folderId : string​

ID of the folder that the group belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the group. The name is unique within the folder.

description : string​

Description of the group.

labels : string​

Resource labels as key:value pairs.

zoneId : string​

Availability zone where all dedicated hosts are allocated.

status : Status​

Status of the group.

typeId : string​

ID of host type. Resources provided by each host of the group.

maintenancePolicy : MaintenancePolicy​

Behaviour on maintenance events.

scalePolicy : ScalePolicy​

Scale policy. Only fixed number of hosts are supported at this moment.

HostType​

Represents host resources. Note: Platform can use hosts with different number of memory and cores. TODO: Do we need sockets here?

id : string​

Unique type identifier.

cores : int64​

Total number of cores available for instances.

memory : int64​

Ammount of memory available for instances.

disks : int64​

Number of local disks available for instances

diskSize : int64​

Size of each local disk

Image​

An Image resource.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    Image is being created.

  • READY

    Image is ready to use.

  • ERROR

    Image encountered a problem and cannot operate.

  • DELETING

    Image is being deleted.

id : string​

ID of the image.

folderId : string​

ID of the folder that the image belongs to.

createdAt : google.protobuf.Timestamp​
name : string​

Name of the image. 1-63 characters long.

description : string​

Description of the image. 0-256 characters long.

labels : string​

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

family : string​

The name of the image family to which this image belongs.

You can get the most recent image from a family by using the yandex.cloud.compute.v1.ImageService.GetLatestByFamily request and create the disk from this image.

storageSize : int64​

The size of the image, specified in bytes.

minDiskSize : int64​

Minimum size of the disk which will be created from this image.

productIds : string​

License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.

The correct license ID is generated by the platform. IDs are inherited by new resources created from this resource.

If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.

status : Status​

Current status of the image.

os : Os​

Operating system that is contained in the image.

pooled : bool​

When true, indicates there is an image pool for fast creation disks from the image.

hardwareGeneration : HardwareGeneration​

If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used.

kmsKey : KMSKey​

Key encryption key info.

Instance​

An Instance resource. For more information, see Instances.

Status​

  • STATUS_UNSPECIFIED

  • PROVISIONING

    Instance is waiting for resources to be allocated.

  • RUNNING

    Instance is running normally.

  • STOPPING

    Instance is being stopped.

  • STOPPED

    Instance stopped.

  • STARTING

    Instance is being started.

  • RESTARTING

    Instance is being restarted.

  • UPDATING

    Instance is being updated.

  • ERROR

    Instance encountered a problem and cannot operate.

  • CRASHED

    Instance crashed and will be restarted automatically.

  • DELETING

    Instance is being deleted.

id : string​

ID of the instance.

folderId : string​

ID of the folder that the instance belongs to.

createdAt : google.protobuf.Timestamp​
name : string​

Name of the instance. 1-63 characters long.

description : string​

Description of the instance. 0-256 characters long.

labels : string​

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

zoneId : string​

ID of the availability zone where the instance resides.

platformId : string​

ID of the hardware platform configuration for the instance.

resources : Resources​

Computing resources of the instance such as the amount of memory and number of cores.

status : Status​

Status of the instance.

metadata : string​

The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys.

For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.

metadataOptions : MetadataOptions​

Options allow user to configure access to instance's metadata

bootDisk : AttachedDisk​

Boot disk that is attached to the instance.

secondaryDisks : AttachedDisk​

Array of secondary disks that are attached to the instance.

localDisks : AttachedLocalDisk​

Array of local disks that are attached to the instance.

filesystems : AttachedFilesystem​

Array of filesystems that are attached to the instance.

networkInterfaces : NetworkInterface​

Array of network interfaces that are attached to the instance.

serialPortSettings : SerialPortSettings​

Serial port settings

gpuSettings : GpuSettings​

GPU settings

fqdn : string​

A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.

schedulingPolicy : SchedulingPolicy​

Scheduling policy configuration.

serviceAccountId : string​

ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.

networkSettings : NetworkSettings​

Network Settings

placementPolicy : PlacementPolicy​

Placement policy configuration.

hostGroupId : string​

ID of the dedicated host group that the instance belongs to.

hostId : string​

ID of the dedicated host that the instance belongs to.

maintenancePolicy : MaintenancePolicy​

Behaviour on maintenance events

maintenanceGracePeriod : google.protobuf.Duration​

Time between notification via metadata service and maintenance

hardwareGeneration : HardwareGeneration​

This feature set is inherited from the image/disk used as a boot one at the creation of the instance.

KMSKey​

keyId : string​

ID of KMS symmetric key

versionId : string​

Version of KMS symmetric key

LegacyHardwareFeatures​

A first hardware generation, by default compatible with all legacy images. Allows switching to PCI_TOPOLOGY_V2 and back.

pciTopology : PCITopology​

MetadataOptions​

gceHttpEndpoint : MetadataOption​

Enabled access to GCE flavored metadata

awsV1HttpEndpoint : MetadataOption​

Enabled access to AWS flavored metadata (IMDSv1)

gceHttpToken : MetadataOption​

Enabled access to IAM credentials with GCE flavored metadata

awsV1HttpToken : MetadataOption​

Enabled access to IAM credentials with AWS flavored metadata (IMDSv1)

NetworkInterface​

index : string​

The index of the network interface, will be generated by the server, 0,1,2... etc if not specified.

macAddress : string​

MAC address that is assigned to the network interface.

subnetId : string​

ID of the subnet.

primaryV4Address : PrimaryAddress​

Primary IPv4 address that is assigned to the instance for this network interface.

primaryV6Address : PrimaryAddress​

Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet.

securityGroupIds : string​

ID's of security groups attached to the interface

NetworkSettings​

Type​

  • TYPE_UNSPECIFIED

  • STANDARD

    Standard network.

  • SOFTWARE_ACCELERATED

    Software accelerated network.

  • HARDWARE_ACCELERATED

    Hardware accelerated network (not available yet, reserved for future use).

type : Type​

Network Type

OneToOneNat​

address : string​

An external IP address associated with this instance.

ipVersion : IpVersion​

IP version for the external IP address.

dnsRecords : DnsRecord​

External DNS configuration

Os​

Type​

  • TYPE_UNSPECIFIED

  • LINUX

    Linux operating system.

  • WINDOWS

    Windows operating system.

type : Type​

Operating system type. The default is LINUX.

This field is used to correctly emulate a vCPU and calculate the cost of using an instance.

PartitionPlacementStrategy​

partitions : int64​

PlacementGroup​

id : string​

ID of the placement group. Generated at creation time.

folderId : string​

ID of the folder that the placement group belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the placement group. The name is unique within the folder.

description : string​

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

labels : string​

Placement group labels as key:value pairs.

  • spreadPlacementStrategy : SpreadPlacementStrategy​
    Anti-affinity placement strategy (`spread`). Instances are distributed

    over distinct failure domains.

  • partitionPlacementStrategy : PartitionPlacementStrategy​

PlacementPolicy​

HostAffinityRule​

Affinity definition

Operator​
  • OPERATOR_UNSPECIFIED

  • IN

  • NOT_IN

key : string​

Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'

op : Operator​

Include or exclude action

values : string​

Affinity value or host ID or host group ID

placementGroupId : string​

Placement group ID.

hostAffinityRules : HostAffinityRule​

List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

placementGroupPartition : int64​

Placement group partition

PrimaryAddress​

address : string​

An IPv4 internal network address that is assigned to the instance for this network interface.

oneToOneNat : OneToOneNat​

One-to-one NAT configuration. If missing, NAT has not been set up.

dnsRecords : DnsRecord​

Internal DNS configuration

Replacement​

hostId : string​

ID of the host which replaces this one.

deadlineAt : google.protobuf.Timestamp​

The date and time when this host will be automatically freed of instances.

Resources​

memory : int64​

The amount of memory available to the instance, specified in bytes.

cores : int64​

The number of cores available to the instance.

coreFraction : int64​

Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.

gpus : int64​

The number of GPUs available to the instance.

ScalePolicy​

FixedScale​

size : int64​

One of scaleType​

  • fixedScale : FixedScale​

SchedulePolicy​

A resource for frequency settings of a snapshot schedule.

startAt : google.protobuf.Timestamp​

Timestamp for creating the first snapshot.

expression : string​

Cron expression for the snapshot schedule (UTC+0).

The expression must consist of five fields (Minutes Hours Day-of-month Month Day-of-week) or be one of nonstandard predefined expressions (e.g. @hourly). For details about the format, see documentation

SchedulingPolicy​

preemptible : bool​

True for short-lived compute instances. For more information, see Preemptible VMs.

SerialPortSettings​

SSHAuthorization​

  • SSH_AUTHORIZATION_UNSPECIFIED

  • INSTANCE_METADATA

    Authentication and authorization using SSH keys in instance metadata

  • OS_LOGIN

    Authentication and authorization using Oslogin service

sshAuthorization : SSHAuthorization​

Authentication and authorization in serial console when using SSH protocol

Snapshot​

A Snapshot resource. For more information, see Snapshots.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    Snapshot is being created.

  • READY

    Snapshot is ready to use.

  • ERROR

    Snapshot encountered a problem and cannot operate.

  • DELETING

    Snapshot is being deleted.

id : string​

ID of the snapshot.

folderId : string​

ID of the folder that the snapshot belongs to.

createdAt : google.protobuf.Timestamp​
name : string​

Name of the snapshot. 1-63 characters long.

description : string​

Description of the snapshot. 0-256 characters long.

labels : string​

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

storageSize : int64​

Size of the snapshot, specified in bytes.

diskSize : int64​

Size of the disk when the snapshot was created, specified in bytes.

productIds : string​

License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.

The correct license ID is generated by the platform. IDs are inherited by new resources created from this resource.

If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.

status : Status​

Current status of the snapshot.

sourceDiskId : string​

ID of the source disk used to create this snapshot.

hardwareGeneration : HardwareGeneration​

If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used.

kmsKey : KMSKey​

Key encryption key info.

SnapshotSchedule​

A snapshot schedule. For details about the concept, see documentation.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    The snapshot schedule is being created.

  • ACTIVE

    The snapshot schedule is on: new disk snapshots will be created, old ones deleted (if [SnapshotSchedule.retention_policy][7] is specified).

  • INACTIVE

    The schedule is interrupted, snapshots won't be created or deleted.

  • DELETING

    The schedule is being deleted.

  • UPDATING

    Changes are being made to snapshot schedule settings or a list of attached disks.

id : string​

ID of the snapshot schedule.

folderId : string​

ID of the folder that the snapshot schedule belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the snapshot schedule.

The name is unique within the folder.

description : string​

Description of the snapshot schedule.

labels : string​

Snapshot schedule labels as key:value pairs.

status : Status​

Status of the snapshot schedule.

schedulePolicy : SchedulePolicy​

Frequency settings of the snapshot schedule.

One of retentionPolicy​

Retention policy of the snapshot schedule.

  • retentionPeriod : google.protobuf.Duration​
    Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is

    automatically deleted.

  • snapshotCount : int64​
    Retention count of the snapshot schedule. Once the number of snapshots created by the schedule exceeds this

    number, the oldest ones are automatically deleted. E.g. if the number is 5, the first snapshot is deleted after the sixth one is created, the second is deleted after the seventh one is created, and so on.

snapshotSpec : SnapshotSpec​

Attributes of snapshots created by the snapshot schedule.

SnapshotSpec​

A resource for attributes of snapshots created by the snapshot schedule.

description : string​

Description of the created snapshot.

labels : string​

Snapshot labels as key:value pairs.

SpreadPlacementStrategy​

This is an empty structure that must be passed to explicitly specify the required placement strategy.

Zone​

Availability zone. For more information, see Availability zones.

Status​

  • STATUS_UNSPECIFIED

  • UP

    Zone is available. You can access the resources allocated in this zone.

  • DOWN

    Zone is not available.

id : string​

ID of the zone.

regionId : string​

ID of the region.

status : Status​

Status of the zone.