Retrieving the Data Source
This data source can be retrieved by one of ID or name.Retrieve by ID
To retrieve by ID, fill in only theid field:
Retrieve by Name
To retrieve by name, fill in only thename and parent_id fields:
Schema
Optional
id(String) Identifier for the resource, unique for its resource type.name(String) Human readable name for the resource.parent_id(String) Identifier of the parent resource to which the resource belongs.
Read-Only
-
boot_disk(Attributes) (see below for nested schema) -
cloud_init_user_data(String, Sensitive) -
created_at(String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM -
filesystems(Attributes List) (see below for nested schema) -
gpu_cluster(Attributes) (see below for nested schema) -
labels(Map of String) : Labels associated with the resource. -
metadata(Attributes) :Inner value description
Common resource metadata. (see below for nested schema) -
network_interfaces(Attributes List) :Inner value description
Describes the specification of a network interface. (see below for nested schema) -
recovery_policy(String) : Recovery policy defines how the instance will be treated in case of a failure. Common source of failure is a host failure, but it can be any other failure. Instance undergoing a guest shutdown (poweroff, etc.) will be subject to recovery policy, meaning that it could be restarted and billed accordingly. Stop instance via API or UI to stop it to avoid recovering.- If set to RECOVER, instance will be restarted, if possible. It could be restarted on the same host or on another host.
- If set to FAIL, instance will be stopped and not restarted.
Supported values
Possible values:RECOVERFAIL
-
resource_version(Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current. -
resources(Attributes) (see below for nested schema) -
secondary_disks(Attributes List) (see below for nested schema) -
service_account_id(String) -
status(Attributes) (see below for nested schema) -
stopped(Boolean) -
updated_at(String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM
Nested Schema for boot_disk
Read-Only:
-
attach_mode(String) :Supported values
Possible values:UNSPECIFIEDREAD_ONLYREAD_WRITE
-
device_name(String) Specifies the user-defined identifier, allowing to use ‘/dev/disk/by-id/virtio-’ as a device path in mount command. -
existing_disk(Attributes) (see below for nested schema)
Nested Schema for boot_disk.existing_disk
Read-Only:
id(String)
Nested Schema for filesystems
Read-Only:
-
attach_mode(String) :Supported values
Possible values:UNSPECIFIEDREAD_ONLYREAD_WRITE
-
device_name(String) Specifies the user-defined identifier, allowing to use it as a device in mount command. -
existing_filesystem(Attributes) (see below for nested schema)
Nested Schema for filesystems.existing_filesystem
Read-Only:
id(String)
Nested Schema for gpu_cluster
Read-Only:
id(String)
Nested Schema for metadata
Nested Schema for network_interfaces
Read-Only:
-
aliases(Attributes List) Assign ranges of IP addresses as aliases (see below for nested schema) -
ip_address(Attributes) : Private IPv4 address associated with the interface.Inner value description
Describes an IPv4 address. (see below for nested schema) -
name(String) : Interface name Value of this field configures the name of the network interface inside VM’s OS. Longer values will persist in the specification but will be truncated to 15 symbols before being passed to VM configuration. -
public_ip_address(Attributes) : Public IPv4 address associated with the interface.Inner value description
Describes a public IP address. (see below for nested schema) -
subnet_id(String) Subnet ID
Nested Schema for network_interfaces.aliases
Read-Only:
allocation_id(String) ID of allocation
Nested Schema for network_interfaces.ip_address
Read-Only:
allocation_id(String) Allocation identifier if it was created before.
Nested Schema for network_interfaces.public_ip_address
Read-Only:
-
allocation_id(String) Allocation identifier if it was created before. -
static(Boolean) : If false - Lifecycle of allocation depends on NetworkInterface.Allocate/NetworkInterface.Deallocate If true - Lifecycle of allocation depends on NetworkInterface.Create/NetworkInterface.Delete False by default
Nested Schema for resources
Read-Only:
platform(String)preset(String)
Nested Schema for secondary_disks
Read-Only:
-
attach_mode(String) :Supported values
Possible values:UNSPECIFIEDREAD_ONLYREAD_WRITE
-
device_name(String) Specifies the user-defined identifier, allowing to use ‘/dev/disk/by-id/virtio-’ as a device path in mount command. -
existing_disk(Attributes) (see below for nested schema)
Nested Schema for secondary_disks.existing_disk
Read-Only:
id(String)
Nested Schema for status
Read-Only:
-
network_interfaces(Attributes List) :Inner value description
Describes the status of a network interface. (see below for nested schema) -
reconciling(Boolean) Indicates whether there is an ongoing operation -
state(String) :Supported values
Possible values:UNSPECIFIEDCREATINGUPDATINGSTARTINGRUNNINGSTOPPINGSTOPPEDDELETINGERROR
Nested Schema for status.network_interfaces
Read-Only:
-
aliases(Attributes) Effective IP Aliases (see below for nested schema) -
index(Number) The index of the network interface -
ip_address(Attributes) Effective Private IPv4 address (see below for nested schema) -
mac_address(String) MAC address -
name(String) : Name for interface. Unique within instance’s network interfaces -
public_ip_address(Attributes) Effective Public IPv4 address (see below for nested schema)
Nested Schema for status.network_interfaces.aliases
Read-Only:
cidrs(List of String)
Nested Schema for status.network_interfaces.ip_address
Read-Only:
address(String) Effective private IPv4 address assigned to the interface.allocation_id(String) Allocation identifier.
Nested Schema for status.network_interfaces.public_ip_address
Read-Only:
address(String) Effective public IPv4 address assigned to the interface.allocation_id(String) Allocation identifier.