Retrieve an EBS volume

Returns a representation of the specified EBS volume.

Path Parameters

volume_id string required
Performs the operation on the EBS Volume 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 Link Description
read-policy-definition Embeds the associated policy of a protected EBS volume 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.

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

Responses

200
default

Success

application/api.clumio.aws-ebs-volumes=v1+json

Schema
Example (from schema)

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 EBS volume.
aws_az string
The AWS availability zone in which the EBS volume resides. For example, us-west-2a.
aws_region string
The AWS region associated with the EBS volume.
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 volume was deleted. Represented in RFC-3339 format. If this volume 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 EBS volume.
has_direct_assignment boolean
Determines whether the table has a direct assignment.
id string
The Clumio-assigned ID of the EBS volume.
iops int64
Iops of the volume.
is_deleted boolean
Determines whether the EBS volume has been deleted. If true, the volume has been deleted.
is_encrypted boolean
Determines whether the EBS volume is encrypted. If true, the volume is encrypted.
is_supported boolean
Determines whether the EBS volume is supported for backups.
kms_key_native_id string
The AWS-assigned ID of the KMS key encrypting the EBS volume. If the volume is unencrypted, then this field has a value of null.
last_backup_timestamp string
The timestamp of the most recent backup of the EBS volume. Represented in RFC-3339 format. If the volume 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 EBS volume taken as part of Snapshot Manager. Represented in RFC-3339 format. If the volume has never been snapshotted, then this field has a value of null.
name string
The AWS-assigned name of the EBS volume.
organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the EBS volume.
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 EBS volume. Possible values include "protected", "unprotected", and "unsupported". If the EBS volume does not support backups, then this field has a value of unsupported. If the volume has been deleted, then this field has a value of null.
size int64
The size of the EBS volume. Measured in bytes (B).
tags object[]
The AWS tags applied to the EBS volume.
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 type of EBS volume. Possible values include "gp2", "io1", "st1", "sc1", and "standard".
unsupported_reason string
The reason why protection is not available. If the volume is supported, then this field has a value of null.
volume_native_id string
The AWS-assigned ID of the EBS volume.

Inheriting Entity Type	Details
aws_tag	AWS tag.

{
  "_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",
  "iops": 0,
  "is_deleted": true,
  "is_encrypted": true,
  "is_supported": true,
  "kms_key_native_id": "string",
  "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",
  "size": 0,
  "tags": [
    {
      "id": "string",
      "key": "string",
      "key_id": "string",
      "value": "string"
    }
  ],
  "type": "string",
  "unsupported_reason": "string",
  "volume_native_id": "string"
}

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"
    }
  ]
}

GET /datasources/aws/ebs-volumes/:volume_id

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

volume_id — path required

lookback_days — query

embed — query

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ebs-volumes/:volume_id' \
-H 'Accept: application/api.clumio.aws-ebs-volumes=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ebs-volumes/:volume_id' \
-H 'Accept: application/api.clumio.aws-ebs-volumes=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ebs-volumes/:volume_id' \
-H 'Accept: application/api.clumio.aws-ebs-volumes=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ebs-volumes/:volume_id' \
-H 'Accept: application/api.clumio.aws-ebs-volumes=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ebs-volumes/:volume_id' \
-H 'Accept: application/api.clumio.aws-ebs-volumes=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ebs-volumes/:volume_id' \
-H 'Accept: application/api.clumio.aws-ebs-volumes=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ebs-volumes/:volume_id' \
-H 'Accept: application/api.clumio.aws-ebs-volumes=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

Retrieve an EBS volume​

Authorization

Request

Retrieve an EBS volume