List EC2 instances

Returns a list of EC2 instances.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

filter string

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
environment_id	$eq	The Clumio-assigned ID of the AWS environment.
name	$contains, $eq	The AWS-assigned name of this resource to conditionalize on. For example, `?filter={"name":{"$contains":"dev"}}` retrieves all EC2 instances with "dev" in their name. `?filter={"name":{"$eq":"dev"}} retrieves only EC2 instances with names that exactly match "dev"`
instance_native_id	$eq, $contains	The AWS-assigned ID of the EC2 instance. For example, `?filter={"instance_native_id":{"$eq":"i-07aa02a849fe376d0"}}` or `?filter={"instance_native_id":{"$contains":"2a849fe37"}}` Both filter operations cannot be used simultaneously.
account_native_id	$eq	The AWS-assigned ID of the AWS account. For example, `?filter={"account_native_id":{"$eq":"789901323485"}}`
aws_region	$eq	The AWS region of a given account to which this resource belongs. For example, `?filter={"aws_region":{"$eq":"us-east-1"}}`
protection_status	$in	The protection status of the EC2 instance. Possible values include "protected", "unprotected", and "unsupported". For example, `?filter={"protection_status":{"$in":["protected"]}}`
backup_status	$in	The backup status of this resource. Possible values include `success`, `partial_success`, `failure` and `no_backup`.
deactivated	$eq	Filter assets protected by a deactivated policy.
protection_info.policy_id	$eq	The Clumio-assigned ID of the policy protecting this resource. `?filter={"protection_info.policy_id":{"$eq":"c764abb6-5819-16ea-bb9f-b2e1c9a040ad"}}`
tags.id	$all	The ID of the AWS tag applied to the EC2 instance. For example, `?filter={"tags.id":{"$all":["c764b152-5819-11ea-bb9f-b2e1c9a040ad","c764abb6-5819-11ea-bb9f-b2e1c9a040ad"]}}`. If multiple tags are specified, all of them must be applied to the same EC2 instance.
is_deleted	$eq, $in	The deletion status of the EC2 instance. Default value is "false". Set to "true" to retrieve deleted EC2 instance. For example, `?filter={"is_deleted":{"$eq":true}}` `?filter={"is_deleted":{"$in":["true","false"]}}`
availability_zone	$eq	The AWS availability zone. For example, `?filter={"availability_zone":{"$eq":"us-east-1a"}}`

For more information about filtering, refer to the Filtering section of this guide.

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

Embeddable Link Description
read-policy-definition Embeds 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.
lookback_days int64
Calculate backup status for the last lookback_days days.

Embeddable Link	Description
read-policy-definition	Embeds the associated policy of a protected EC2 instance into the response. For example, `?embed=read-policy-definition`

Responses

200
default

Success

application/api.clumio.aws-ec2-instances=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_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 Type Details
aws_tag AWS 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.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
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.
_last object
The HATEOAS link to the last page of results.
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.
_next object
The HATEOAS link to the next page of results.
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.
_prev object
The HATEOAS link to the previous page of results.
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.
_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.
current_count int64
The number of items listed on the current page.
limit int64
The maximum number of items displayed per page in the response.
start string
The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").
total_count int64
The total number of items, summed across all pages.
total_pages_count int64
The total number of pages of results.

Inheriting Entity Type	Details
aws_tag	AWS tag.

{
  "_embedded": {
    "items": [
      {
        "_embedded": {},
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "account_native_id": "string",
        "aws_az": "string",
        "aws_region": "string",
        "backup_status_info": {
          "backup_status": "string",
          "last_failed_policy_start_timestamp": "string",
          "last_successful_policy_start_timestamp": "string",
          "operation_info_list": [
            {
              "backup_status": "string",
              "last_failed_policy_start_timestamp": "string",
              "last_successful_policy_start_timestamp": "string",
              "operation": "string"
            }
          ]
        },
        "deletion_timestamp": "string",
        "direct_assignment_policy_id": "string",
        "environment_id": "string",
        "has_direct_assignment": true,
        "id": "string",
        "instance_native_id": "string",
        "is_deleted": true,
        "is_supported": true,
        "last_backup_timestamp": "string",
        "last_snapshot_timestamp": "string",
        "name": "string",
        "organizational_unit_id": "string",
        "protection_info": {
          "inheriting_entity_id": "string",
          "inheriting_entity_type": "string",
          "policy_id": "string"
        },
        "protection_status": "string",
        "state": "string",
        "subnet_id": "string",
        "tags": [
          {
            "id": "string",
            "key": "string",
            "key_id": "string",
            "value": "string"
          }
        ],
        "type": "string",
        "unsupported_reason": "string",
        "vpc_id": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

List EC2 instances​

List EC2 instances