List Databases

Returns a list of Databases

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
name	$contains	Filter database where given string is a substring of the name.
environment_id	$eq	The Clumio-assigned ID of the AWS environment.
protection_info.policy_id	$eq	Filter database whose policy_id is equal to the given string.
protection_status	$eq	Filter database whose protection_status is equal to the given string.
backup_status	$in	The backup status of this resource. Possible values include `success`, `partial_success`, `failure` and `no_backup`.
deactivated	$eq	Filter database which is protected by deactivated policy or not.
instance_id	$eq	Filter database whose instance ID is equal to the given string.
host_id	$eq	Filter database whose host ID is equal to the given string.
availability_group_id	$eq	Filter database whose availability group ID is equal to the given string.
failover_cluster_id	$eq	Filter database whose failover cluster ID is equal to the given string.
status	$eq	Filter database whose status is equal to the given string.
recovery_model	$in	Filter database whose recovery_model is in the given array of string
type	$eq	Filter database whose type is equal to the given string.
account_ids	$in	Filter databases which belong to any one or more of the accounts in the list of account_ids.

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

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 definition of the policy associated with this resource. Unprotected resources will not have an associated policy. For example, `?embed=read-policy-definition`
read-aws-environment	Embeds the associated AWS Environment details in the response. For example, `?embed=read-aws-environment`
read-aws-ec2-instance	Embeds the associated AWS EC2 Instance in the response. For example, `?embed=read-aws-ec2-instance`

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

200
default

Success

application/api.clumio.ec2-mssql-databases=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.
get-ec2-mssql-failover-clusters-hosts-info
Embed information about the Hosts part of FCI databases
read-aws-ec2-instance
AWS inventory EC2 Instance embed
read-aws-environment
Embed information for AWS Environment details
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.
create-backup-ec2-mssql-database object
A resource-specific HATEOAS link.
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.
list-backup-ec2-mssql-databases object
A resource-specific HATEOAS link.
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-aws-ec2-instance object
A resource-specific HATEOAS link.
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-aws-environment object
A resource-specific HATEOAS link.
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 the database resides in.
availability_group_id string
The Clumio-assigned ID of the availability group. It is null in case of a standalone database.
availability_group_name string
The Microsoft SQL assigned name of the availability group. It is null in case of a standalone database.
aws_region string
The AWS region associated with the EC2 instance the database resides in.
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.
environment_id string
The Clumio-assigned ID of the AWS environment associated with the EC2 MSSQL database.
failover_cluster_id string
The Clumio-assigned ID of the failover cluster.
failover_cluster_name string
The Microsoft SQL assigned name of the Failover Cluster
failover_cluster_protection_status string
Failovercluster Protection Status is used to indicate the fci protection status associated with the fci database
host_connection_id string
The Clumio-assigned ID of the host connection containing the given database.
host_endpoint string
The user-provided endpoint of the host containing the given database.
host_id string
The Clumio-assigned ID of the host containing the given database.
id string
The Clumio-assigned ID of the Database.
instance_id string
The Clumio-assigned ID of the instance containing the given database.
instance_name string
The name of the Microsoft SQL instance containing the given database.
is_supported boolean
is_supported is true if Clumio supports backup of the database.
last_backup_timestamp string
The timestamp of the last time this database was full backed up. Represented in RFC-3339 format. If this database has never been backed up, this field has a value of null.
last_bulk_recovery_model_log_backup_timestamp string
The timestamp of the last time this database was log backed up in Bulk Recovery Model. Represented in RFC-3339 format. If this database has never been backed up, this field has a value of null.
last_full_recovery_model_log_backup_timestamp string
The timestamp of the last time this database was log backed up in Full Recovery Model. Represented in RFC-3339 format. If this database has never been backed up, this field has a value of null.
name string
The name of the Database.
organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the database.
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.
recovery_model string
recovery_model is the recovery model of the database. Possible values include 'simple_recovery_model', 'bulk_recovery_model', and 'full_recovery_model'.
size float
The size of the Database.
status string
The status of the database, Possible values include 'active' and 'inactive'.
type string
The type of the database. Possible values include 'availability_group_database' and 'standalone_database'.
unsupported_reason string
unsupported_reason is the reason why Clumio doesn't support backup of such database, possible values include 'filestream_enabled_database'.
_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.
filter_applied string
The filter used in the request. The filter includes both manually-specified and system-generated filters.
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"
          },
          "create-backup-ec2-mssql-database": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "list-backup-ec2-mssql-databases": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-aws-ec2-instance": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-aws-environment": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "account_native_id": "string",
        "availability_group_id": "string",
        "availability_group_name": "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"
            }
          ]
        },
        "environment_id": "string",
        "failover_cluster_id": "string",
        "failover_cluster_name": "string",
        "failover_cluster_protection_status": "string",
        "host_connection_id": "string",
        "host_endpoint": "string",
        "host_id": "string",
        "id": "string",
        "instance_id": "string",
        "instance_name": "string",
        "is_supported": true,
        "last_backup_timestamp": "string",
        "last_bulk_recovery_model_log_backup_timestamp": "string",
        "last_full_recovery_model_log_backup_timestamp": "string",
        "name": "string",
        "organizational_unit_id": "string",
        "protection_info": {
          "inheriting_entity_id": "string",
          "inheriting_entity_type": "string",
          "policy_id": "string"
        },
        "recovery_model": "string",
        "size": 0,
        "status": "string",
        "type": "string",
        "unsupported_reason": "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,
  "filter_applied": "string",
  "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 Databases​

List Databases