Summary of data returned by the metadata service
Use the metadata service to access information about the instance, SSH keys, and placement groups. The following summary contains the URI paths and metadata keys, and describes the metadata.
The API response for each metadata type is presented in JSON format that contains metadata key:value pairs.
Summary of metadata for instances
Use the information in the Table 1 to understand the type of metadata returned for an instance. To access all metadata, see Retrieving metadata from an instance.
| Instance URI path | Metadata key | Description of the metadata |
|---|---|---|
/instance |
availability_policy |
The availability policy for this virtual server instance. |
/instance |
bandwidth |
The total bandwidth in megabits per second that is shared across the virtual server instance's network interfaces and Block Storage volumes. |
/instance |
boot_volume_attachment |
Boot volume attachment, with volume name, CRN, and ID. |
/instance |
catalog_offering |
This information is displayed if the virtual server instance was provisioned with a custom image in a private catalog. |
/instance |
created_at |
The date and time that the virtual server instance was created. |
/instance |
crn |
The Cloud Resource Name for this virtual server instance. |
/instance |
dedicated_host |
Collection of the dedicated host references, which includes the CRN, deleted hosts, ID, name, and resource_type. |
/instance |
disks |
A list of the instance's disks. |
/instance |
gpu |
The virtual server instance GPU configuration |
/instance |
id |
The unique identifier for this virtual server instance. |
/instance |
image |
The image from which the virtual server instance was provisioned. For example, a Debian Linux stock image. |
/instance |
lifecycle_reasons |
The reasons for the current lifecycle_state. |
/instance |
lifecycle_state |
The lifecycle state of the virtual server instance. |
/instance |
memory |
The amount of memory; truncated to whole gigabytes. |
/instance |
metadata_service |
Indicates whether the metadata service endpoint is available to the virtual server instance. (Enabled status is true or false.) |
/instance |
name |
The user-defined name for this virtual server instance (and default system hostname). |
/instance |
network_interfaces |
A list of the virtual server instance's network interfaces, including the primary network interface. |
/instance |
placement_target |
The placement restrictions for the virtual server instance. |
/instance |
primary_network_interface |
The instance's primary network interface. |
/instance |
profile |
The globally unique name for this virtual server instance profile. For example, a bx2-2x8, balanced profile. |
/instance |
software_attachments |
A list of the virtual server instance's software attachments. |
/instance |
startable |
Indicates whether the state of the virtual server instance permits a start request. |
/instance |
status |
The status of the instance: deleting, failed, paused, pausing, pending, restarting, resuming, running, starting, stopped, or stopping. |
/instance |
status_reasons |
The reasons for the current status. |
/instance |
total_network_bandwidth |
The amount of bandwidth in megabits per second that is allocated exclusively to instance network interfaces. |
/instance |
total_volume_bandwidth |
The amount of bandwidth in megabits per second allocated exclusively to the instance's Block Storage volumes. Increasing this value results in a corresponding decrease to total_network_bandwidth. |
/instance |
vcpu |
The number of VCPUs that are assigned by way of a structure that includes count and architecture properties. |
/instance |
volume_attachments |
A list of the virtual server instance's volume attachments. |
/instance |
boot_volume_attachment |
Instance's boot volume attachment. |
/instance |
volume_bandwidth_qos_mode |
The volume bandwidth QoS mode for this virtual server instance. Either pooled or weighted. |
/instance |
vpc |
The VPC in which the virtual server instance resides. |
/instance |
zone |
The globally unique name for the zone. |
/instance/initialization |
default_trusted_profile |
The default trusted profile configuration that was specified at virtual server instance creation. |
/instance/initialization |
keys |
A list of references to public SSH keys that were used at instance initialization. |
/instance/initialization |
password |
The administrator password at initialization, encrypted using encryption_key, and returned Base64-encoded. |
/instance/initialization |
user_data |
User data that is made available when you set up a new virtual server instance. |
/instance/network_interfaces |
network_interfaces |
A list of network interfaces. See /instance/network_interfaces/{id} for details. |
/instance/network_interfaces/{id} |
allow_ip_spoofing |
Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface. |
/instance/network_interfaces/{id} |
created_at |
The date and time that the network interface was created. |
/instance/network_interfaces/{id} |
floating_ips |
Array of references to floating IP addresses associated with the network interface. |
/instance/network_interfaces/{id} |
id |
The unique identifier for the network interface. |
/instance/network_interfaces/{id} |
name |
The user-defined name for the network interface. |
/instance/network_interfaces/{id} |
port_speed |
The network interface port speed in Mbps. |
/instance/network_interfaces/{id} |
primary_ipv4_address |
The primary IPv4 address. |
/instance/network_interfaces/{id} |
resource_type |
The resource type. |
/instance/network_interfaces/{id} |
security_groups |
A list of security groups. |
/instance/network_interfaces/{id} |
status |
The status of the network interface. |
/instance/network_interfaces/{id} |
subnet |
The subnet associated with the instance. |
/instance/network_interfaces/{id} |
type |
The type of this network interface as it relates to an instance. |
/instance/software_attachments |
software_attachments |
An array of zero or more software attachment objects. |
/instance/software_attachments/{id} |
id |
The unique identifier (UUID) for this software attachment. |
/instance/software_attachments/{id} |
name |
The name for this software attachment. The name is unique within the set of software attachments associated with the virtual server instance. |
/instance/software_attachments/{id} |
href |
The URL for this software attachment. |
/instance/software_attachments/{id} |
catalog_offering |
An object containing the catalog offering version CRN and associated software plan CRN representing the software. |
/instance/software_attachments/{id} |
offering_instance |
An object representing the software offering instance instantiated from the software plan. Contains the CRN of the software offering instance. |
/instance/software_attachments/{id} |
entitlement |
An object representing the license entitlement for the software offering instance. This property is populated dynamically after a successful call to License Manager to get the entitlement. |
/instance/software_attachments/{id} |
entitlement.licensed_software |
An array of zero or more objects, each representing an installed, licensed software program or feature in the virtual server instance. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
The SKU (Stock Keeping Unit) of one licensable software program or feature associated with the software plan and running on the virtual server instance. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].key |
The license key for the software entitlement. This property's value may change over time. |
/instance/software_attachments/{id} |
lifecycle_state |
The lifecycle state of the software attachment, indicating whether it is complete and usable. |
/instance/software_attachments/{id} |
lifecycle_reasons |
An array of reasons for the current lifecycle_state. |
/instance/software_attachments/{id} |
resource_type |
The resource type. Set to instance_software_attachment. |
/instance/software_attachments/{id} |
created_at |
The date and time that this software attachment was created. |
/instance/volume_attachments/{id} |
bandwidth |
The maximum bandwidth in megabits per second for the volume when it's attached to this instance. This value might be less than the volume bandwidth depending on the configuration of the instance. |
/instance/volume_attachments/{id} |
created_at |
The date and time that the volume was attached. |
/instance/volume_attachments/{id} |
delete_volume_on_instance_delete |
If set to true, then when you delete the instance, the volume is also deleted. |
/instance/volume_attachments/{id} |
device |
Information about how the volume is exposed to the instance operating system. |
/instance/volume_attachments/{id} |
id |
The unique identifier for the volume attachment. |
/instance/volume_attachments/{id} |
name |
The user-defined name for the volume attachment. |
/instance/volume_attachments/{id} |
status |
The status of the volume attachment: attached, attaching, deleting, or detaching. |
/instance/volume_attachments/{id} |
type |
The type of volume attachment, boot or data. |
/instance/volume_attachments/{id} |
volume |
The attached volume, which contains the CRN, ID, name, and deleted value, when the volume is deleted. |
Summary of metadata for SSH keys
Use the information in the Table 2 to understand the type of metadata returned for SSH keys.
| SSH Key URI path | Metadata key | Description of the metadata |
|---|---|---|
/keys |
keys |
A collection of keys. See keys/{id} for details. |
/keys/{id} |
created_at |
The date and time that the key was created. |
/keys/{id} |
crn |
The Cloud Resource Name for the key. |
/keys/{id} |
fingerprint |
The fingerprint for the key. The value is returned Base64-encoded and prefixed with the hash algorithm (always SHA256). |
/keys/{id} |
id |
The unique identifier for the key. |
/keys/{id} |
length |
The length of the key, in bits. |
/keys/{id} |
name |
The unique user-defined name for the key. If unspecified, the name is a hyphenated list of randomly selected words (for example, elderly-mountain-troop-opponent.) |
/keys/{id} |
public_key |
The public SSH key. |
/keys/{id} |
type |
The cryptosystem used by the key. |
Summary of metadata for placement groups
Use the information in the Table 3 to understand the type of metadata returned for placement groups.
| Placement group URI path | Metadata key | Description of the metadata |
|---|---|---|
/placement_groups |
placement_groups |
A collection of placement groups. See placement_groups/{id} for details. |
/placement_groups/{id} |
created_at |
The date and time that the placement group was created. |
/placement_groups/{id} |
crn |
The Cloud Resource Name for the placement group. |
/placement_groups/{id} |
id |
The unique identifier for the placement group. |
/placement_groups/{id} |
lifecycle_state |
The lifecycle state of the placement group. |
/placement_groups/{id} |
name |
The user-defined name for the placement group. |
/placement_groups/{id} |
resource_type |
The resource type. |
/placement_groups/{id} |
strategy |
The strategy for the placement group. |
Summary of metadata for software attachments
Use the information in the following table to understand the type of metadata returned for software attachments.
The /metadata/v1/instance/software_attachments endpoint returns an array of zero or more software attachment objects. Each object represents a resource-controller-registered software instance corresponding to a software plan.
| Software attachments URI path | Metadata key | Description of the metadata |
|---|---|---|
/instance/software_attachments/{id} |
id |
A unique UUID for the software attachment. |
/instance/software_attachments/{id} |
name |
A name unique within the set of software attachments associated with the virtual server instance. This name is set to a system-generated random value and may be updated by the owner thereafter if desired. Note that updating the name in the virtual server instance software attachment does not affect that of the attached boot volume or any snapshots already created from that volume. |
/instance/software_attachments/{id} |
href |
The URL for this software attachment. |
/instance/software_attachments/{id} |
catalog_offering |
An object whose value is the same as the instance's object of the same name, containing the catalog offering version CRN and associated software plan CRN representing the software. |
/instance/software_attachments/{id} |
offering_instance |
An object representing the software offering instance instantiated from the software plan. |
/instance/software_attachments/{id} |
offering_instance.crn |
The software offering instance CRN. |
/instance/software_attachments/{id} |
entitlement (optional) |
An object representing the license entitlement for the software offering instance. If absent, no license is associated with the software plan. |
/instance/software_attachments/{id} |
entitlement.licensed_software |
An array of zero or more objects, each representing an installed, licensed software program or feature in the virtual server instance. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
The SKU (Stock Keeping Unit) of one licensable software program or feature associated with the software plan and running on the virtual server instance. It is meaningful to the software's vendor. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].key (optional) |
The license key for the software entitlement. If absent, the license has not been obtained yet. |
/instance/software_attachments/{id} |
lifecycle_state |
The lifecycle state of the software attachment. If stable, the software instance has been created successfully. |
/instance/software_attachments/{id} |
lifecycle_reasons[] |
The reasons for the current lifecycle_state. |
/instance/software_attachments/{id} |
resource_type |
The resource type, set to instance_software_attachment. |
/instance/software_attachments/{id} |
created_at |
The date and time when this software attachment was created. |