Skip to main content

Retrieve an EC2 instance​

Returns a representation of the specified EC2 instance.

Path Parameters
  • instance_id string required

    Performs the operation on the EC2 instance with the specified ID.

Query Parameters
  • lookback_days int64

    Calculate backup status for the last lookback_days days.

  • embed string

    Embeds the details of an associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

    Embeddable LinkDescription
    read-policy-definitionEmbeds the associated policy of a protected EC2 instance into the response. For example, ?embed=read-policy-definition
    For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.
Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-policy-definition Embeds the associated policy of a protected resource in the response if requested using the `embed` query parameter. Unprotected resources will not have an associated policy.

    Embeds the associated policy of a protected resource in the response if requested using the embed query parameter. Unprotected resources will not have an associated policy.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • read-policy-definition object

    A HATEOAS link to the policy protecting this resource. Will be omitted for unprotected entities.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • account_native_id string

    The AWS-assigned ID of the account associated with the EC2 instance.

  • aws_az string

    The AWS availability zone in which the EC2 instance resides. For example, us-west-2a.

  • aws_region string

    Determines whether the EC2 instance has been deleted. If true, the instance has been deleted.

  • backup_status_info object

    The backup status information applied to this resource.

  • backup_status string

    BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.

  • last_failed_policy_start_timestamp string

    The last failed policy start time. Represented in RFC-3339 format.

  • last_successful_policy_start_timestamp string

    The last successful policy start time. Represented in RFC-3339 format.

  • operation_info_list object[]

    The policy operation information of the backups.

  • backup_status string

    BackupStatus is the status of the backup. Possible values are success, partial_success, failure, no_backup, and unknown. This value depends on lookback_days. If not specified, then this field has a value of unknown.

  • last_failed_policy_start_timestamp string

    The last failed policy start time. Represented in RFC-3339 format.

  • last_successful_policy_start_timestamp string

    The last successful policy start time. Represented in RFC-3339 format.

  • operation string

    The policy operation type.

  • deletion_timestamp string

    The timestamp of when the instance was deleted. Represented in RFC-3339 format. If this instance has not been deleted, then this field has a value of null.

  • direct_assignment_policy_id string

    The Clumio-assigned ID of the policy directly assigned to the entity.

  • environment_id string

    The Clumio-assigned ID of the AWS environment associated with the EC2 instance.

  • has_direct_assignment boolean

    Determines whether the table has a direct assignment.

  • id string

    The Clumio-assigned ID of the EC2 instance.

  • instance_native_id string

    The AWS-assigned ID of the EC2 instance.

  • is_deleted boolean

    Determines whether the EC2 instance has been deleted. If true, the instance has been deleted.

  • is_supported boolean

    Determines whether the EC2 instance is supported for backups.

  • last_backup_timestamp string

    The timestamp of the most recent backup of the EC2 instance. Represented in RFC-3339 format. If the instance has never been backed up, then this field has a value of null.

  • last_snapshot_timestamp string

    The timestamp of the most recent snapshot of the EC2 instance taken as part of the EC2 Snapshot Manager. Represented in RFC-3339 format. If the instance has never been backed up, then this field has a value of null.

  • name string

    The AWS-assigned name of the EC2 instance.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the EC2 instance.

  • protection_info object

    The protection policy applied to this resource. If the resource is not protected, then this field has a value of null.

  • inheriting_entity_id string

    The ID of the entity from which protection was inherited. If protection was not inherited, then this field has a value of null.

  • inheriting_entity_type string

    The type of entity from which protection was inherited. If protection was not inherited, then this field has a value of null.
    Entities from which protection can be inherited include the following:

    Inheriting Entity TypeDetails
    aws_tagAWS tag.
  • policy_id string

    A system-generated ID assigned to the policy protecting this resource.

  • protection_status string

    The protection status of the EC2 instance. Possible values include "protected", "unprotected", and "unsupported". If the EC2 instance does not support backups, then this field has a value of unsupported. If the instance has been deleted, then this field has a value of null.

  • state string

    The state of the EC2 instance. Possible values include: pending, running, terminated, stopped, stopping, shutting-down, rebooting

  • subnet_id string

    The AWS Subnet ID of the EC2 instance

  • tags object[]

    The AWS tags applied to the EC2 instance.

  • id string

    The Clumio-assigned ID of the AWS tag.

  • key string

    The AWS-assigned tag key.

  • key_id string

    The Clumio-assigned ID of the AWS key.

  • value string

    The AWS-assigned tag value.

  • type string

    The AWS region associated with the EC2 instance. Possible instances types can be found in: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

  • unsupported_reason string

    The reason why protection is not available. If the volume is supported, then this field has a value of null.

  • vpc_id string

    AWS-assigned ID of the VPC associated with the EC2 instance.

Loading...