Compute Cloud API, REST: Instance.Get
- HTTP request
- Path parameters
- Query parameters
- Response
- Resources
- MetadataOptions
- AttachedDisk
- AttachedLocalDisk
- AttachedFilesystem
- NetworkInterface
- PrimaryAddress
- OneToOneNat
- DnsRecord
- SerialPortSettings
- GpuSettings
- SchedulingPolicy
- NetworkSettings
- PlacementPolicy
- HostAffinityRule
- HardwareGeneration
- LegacyHardwareFeatures
Returns the specified Instance resource.
To get the list of available Instance resources, make a List request.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/instances/{instanceId}
Path parameters
Field |
Description |
instanceId |
string Required field. ID of the Instance resource to return. |
Query parameters
Field |
Description |
view |
enum (InstanceView) Defines which information about the Instance resource should be returned in the server response.
|
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"zoneId": "string",
"platformId": "string",
"resources": {
"memory": "string",
"cores": "string",
"coreFraction": "string",
"gpus": "string"
},
"status": "string",
"metadata": "string",
"metadataOptions": {
"gceHttpEndpoint": "string",
"awsV1HttpEndpoint": "string",
"gceHttpToken": "string",
"awsV1HttpToken": "string"
},
"bootDisk": {
"mode": "string",
"deviceName": "string",
"autoDelete": "boolean",
"diskId": "string"
},
"secondaryDisks": [
{
"mode": "string",
"deviceName": "string",
"autoDelete": "boolean",
"diskId": "string"
}
],
"localDisks": [
{
"size": "string",
"deviceName": "string"
}
],
"filesystems": [
{
"mode": "string",
"deviceName": "string",
"filesystemId": "string"
}
],
"networkInterfaces": [
{
"index": "string",
"macAddress": "string",
"subnetId": "string",
"primaryV4Address": {
"address": "string",
"oneToOneNat": {
"address": "string",
"ipVersion": "string",
"dnsRecords": [
{
"fqdn": "string",
"dnsZoneId": "string",
"ttl": "string",
"ptr": "boolean"
}
]
},
"dnsRecords": [
{
"fqdn": "string",
"dnsZoneId": "string",
"ttl": "string",
"ptr": "boolean"
}
]
},
"primaryV6Address": {
"address": "string",
"oneToOneNat": {
"address": "string",
"ipVersion": "string",
"dnsRecords": [
{
"fqdn": "string",
"dnsZoneId": "string",
"ttl": "string",
"ptr": "boolean"
}
]
},
"dnsRecords": [
{
"fqdn": "string",
"dnsZoneId": "string",
"ttl": "string",
"ptr": "boolean"
}
]
},
"securityGroupIds": [
"string"
]
}
],
"serialPortSettings": {
"sshAuthorization": "string"
},
"gpuSettings": {
"gpuClusterId": "string"
},
"fqdn": "string",
"schedulingPolicy": {
"preemptible": "boolean"
},
"serviceAccountId": "string",
"networkSettings": {
"type": "string"
},
"placementPolicy": {
"placementGroupId": "string",
"hostAffinityRules": [
{
"key": "string",
"op": "string",
"values": [
"string"
]
}
],
"placementGroupPartition": "string"
},
"hostGroupId": "string",
"hostId": "string",
"maintenancePolicy": "string",
"maintenanceGracePeriod": "string",
"hardwareGeneration": {
// Includes only one of the fields `legacyFeatures`, `generation2Features`
"legacyFeatures": {
"pciTopology": "string"
},
"generation2Features": "object"
// end of the list of possible fields
}
}
An Instance resource. For more information, see Instances.
Field |
Description |
id |
string ID of the instance. |
folderId |
string ID of the folder that the instance belongs to. |
createdAt |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
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 |
zoneId |
string ID of the availability zone where the instance resides. |
platformId |
string ID of the hardware platform configuration for the instance. |
resources |
Computing resources of the instance such as the amount of memory and number of cores. |
status |
enum (Status) Status of the instance.
|
metadata |
string The metadata For example, you may use the metadata in order to provide your public SSH key to the instance. |
metadataOptions |
Options allow user to configure access to instance's metadata |
bootDisk |
Boot disk that is attached to the instance. |
secondaryDisks[] |
Array of secondary disks that are attached to the instance. |
localDisks[] |
Array of local disks that are attached to the instance. |
filesystems[] |
Array of filesystems that are attached to the instance. |
networkInterfaces[] |
Array of network interfaces that are attached to the instance. |
serialPortSettings |
Serial port settings |
gpuSettings |
GPU settings |
fqdn |
string A domain name of the instance. FQDN is defined by the server |
schedulingPolicy |
Scheduling policy configuration. |
serviceAccountId |
string ID of the service account to use for authentication inside the instance. |
networkSettings |
Network Settings |
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 |
enum (MaintenancePolicy) Behaviour on maintenance events
|
maintenanceGracePeriod |
string (duration) Time between notification via metadata service and maintenance |
hardwareGeneration |
This feature set is inherited from the image/disk used as a boot one at the creation of the instance. |
Resources
Field |
Description |
memory |
string (int64) The amount of memory available to the instance, specified in bytes. |
cores |
string (int64) The number of cores available to the instance. |
coreFraction |
string (int64) Baseline level of CPU performance with the ability to burst performance above that baseline level. |
gpus |
string (int64) The number of GPUs available to the instance. |
MetadataOptions
Field |
Description |
gceHttpEndpoint |
enum (MetadataOption) Enabled access to GCE flavored metadata
|
awsV1HttpEndpoint |
enum (MetadataOption) Enabled access to AWS flavored metadata (IMDSv1)
|
gceHttpToken |
enum (MetadataOption) Enabled access to IAM credentials with GCE flavored metadata
|
awsV1HttpToken |
enum (MetadataOption) Enabled access to IAM credentials with AWS flavored metadata (IMDSv1)
|
AttachedDisk
Field |
Description |
mode |
enum (Mode) Access mode to the Disk resource.
|
deviceName |
string Serial number that is reflected into the /dev/disk/by-id/ tree This value can be used to reference the device for mounting, resizing, and so on, from within the instance. |
autoDelete |
boolean 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. |
AttachedLocalDisk
Field |
Description |
size |
string (int64) Size of the disk, specified in bytes. |
deviceName |
string Serial number that is reflected into the /dev/disk/by-id/ tree This value can be used to reference the device for mounting, resizing, and so on, from within the instance. |
AttachedFilesystem
Field |
Description |
mode |
enum (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 |
filesystemId |
string ID of the filesystem that is attached to the instance. |
NetworkInterface
Field |
Description |
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 |
Primary IPv4 address that is assigned to the instance for this network interface. |
primaryV6Address |
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 |
PrimaryAddress
Field |
Description |
address |
string An IPv4 internal network address that is assigned to the instance for this network interface. |
oneToOneNat |
One-to-one NAT configuration. If missing, NAT has not been set up. |
dnsRecords[] |
Internal DNS configuration |
OneToOneNat
Field |
Description |
address |
string An external IP address associated with this instance. |
ipVersion |
enum (IpVersion) IP version for the external IP address.
|
dnsRecords[] |
External DNS configuration |
DnsRecord
Field |
Description |
fqdn |
string Name of the A/AAAA record as specified when creating the instance. |
dnsZoneId |
string DNS zone id for the record (optional, if not set, some private zone is used). |
ttl |
string (int64) DNS record ttl (optional, if not set, a reasonable default is used.) |
ptr |
boolean When true, indicates there is a corresponding auto-created PTR DNS record. |
SerialPortSettings
Field |
Description |
sshAuthorization |
enum (SSHAuthorization) Authentication and authorization in serial console when using SSH protocol
|
GpuSettings
Field |
Description |
gpuClusterId |
string Attach instance to specified GPU cluster. |
SchedulingPolicy
Field |
Description |
preemptible |
boolean True for short-lived compute instances. For more information, see Preemptible VMs. |
NetworkSettings
Field |
Description |
type |
enum (Type) Network Type
|
PlacementPolicy
Field |
Description |
placementGroupId |
string Placement group ID. |
hostAffinityRules[] |
List of affinity rules. Scheduler will attempt to allocate instances according to order of rules. |
placementGroupPartition |
string (int64) Placement group partition |
HostAffinityRule
Affinity definition
Field |
Description |
key |
string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId' |
op |
enum (Operator) Include or exclude action
|
values[] |
string Affinity value or host ID or host group ID |
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.
Field |
Description |
legacyFeatures |
Includes only one of the fields |
generation2Features |
object Includes only one of the fields |
LegacyHardwareFeatures
A first hardware generation, by default compatible with all legacy images.
Allows switching to PCI_TOPOLOGY_V2 and back.
Field |
Description |
pciTopology |
enum (PCITopology)
|