Skip to main content

Retrieve a Database​

Returns a representation of the specified database.

Path Parameters
  • database_id string required

    Performs the operation on a database within the specified database id.

Query Parameters
  • lookback_days int64

    Calculate backup status for the last lookback_days days.

Responses

Success

Schema
  • _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 TypeDetails
    aws_tagAWS 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'.

GET /datasources/aws/ec2-mssql/databases/:database_id

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
database_id — path required
lookback_days — query
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases/:database_id' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'