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:
For more information about filtering, refer to the Filtering section of this guide.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
andno_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. - 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.
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.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
- lookback_days int64
Calculate backup status for the last
lookback_days
days.
- 200
- default
Success
- application/api.clumio.ec2-mssql-databases=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- 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.
{
"_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[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /datasources/aws/ec2-mssql/databases
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/databases' \
-H 'Accept: application/api.clumio.ec2-mssql-databases=v1+json' \
-H 'Authorization: Bearer <TOKEN>'