AWS
EC2
List EC2 instancesget

List EC2 instances

get https://{region}.api.clumio.com/datasources/aws/ec2-instances

Returns a list of EC2 instances.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

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"}}`
compliance_status	$eq, in	The compliance status of the EC2 instance. Possible values include "compliant" and "non_compliant". `?filter={"compliance_status":{"$eq":"non_compliant"}}`
protection_status	$in	The protection status of the EC2 instance. Possible values include "protected", "unprotected", and "unsupported". For example, `?filter={"protection_status":{"$in":["protected"]}}`
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.

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

items

array of objects

A collection of requested items.

items

object

_embedded

object

Embedded responses related to the resource.

_links

object

URLs to pages related to the resource.

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.

compliance_status

string

The compliance status of the protected EC2 instance. Possible values include "compliant" and "noncompliant". If the instance is not protected, then this field has a value of null.

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.

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.

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

string

The Clumio-assigned ID of the AWS tag.

key

string

required

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.

_last

object

The HATEOAS link to the last page of results.

_next

object

The HATEOAS link to the next page of results.

_prev

object

The HATEOAS link to the previous page of results.

_self

object

The HATEOAS link to this resource.

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.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/datasources/aws/ec2-instances \
3
     --header 'accept: application/api.clumio.aws-ec2-instances=v1+json'


xxxxxxxxxx
101
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "_embedded": {},
6
        "_links": {
7
          "_self": {
8
            "href": "string",
9
            "templated": true,
10
            "type": "string"
11
          },
12
          "read-policy-definition": {
13
            "href": "string",
14
            "templated": true,
15
            "type": "string"
16
          }
17
        },
18
        "account_native_id": "string",
19
        "aws_az": "string",
20
        "aws_region": "string",
21
        "backup_status_info": {
22
          "backup_status": "string",
23
          "last_failed_policy_start_timestamp": "string",
24
          "last_successful_policy_start_timestamp": "string",
25
          "operation_info_list": [

200200 HTTP success response

defaultError