List Availability Groups

Returns a list of Availability Groups.

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 availability groups 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 availability groups whose policy_id is equal to the given string.
protection_status	$eq	Filter availability groups whose protection_status is equal to the given string.
status	$eq	Filter Availability Groups whose status is equal to the given string.
host_id	$eq	The Clumio-assigned ID of the host id.
account_ids	$in	Filter AG 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`
get-ec2-mssql-stats-backup-status	Embeds the backup statistics for each resource into the response. For example, `?embed=get-ec2-mssql-stats-backup-status`

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-availability-groups=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-mssql-ec2-availability-group-backup-status-stats
availability group level backup status stats
get-mssql-ec2-availability-group-stats
availability group level protection stats
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.
get-mssql-ec2-availability-group-backup-status-stats 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.
get-mssql-ec2-availability-group-stats 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.
id string
The Clumio-assigned ID of the availability group.
name string
The Microsoft SQL-assigned name of the availability group.
organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the availability group.
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.
status string
The status of the availability group, Possible values include 'active' and 'inactive'.
_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"
          },
          "get-mssql-ec2-availability-group-backup-status-stats": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "get-mssql-ec2-availability-group-stats": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "id": "string",
        "name": "string",
        "organizational_unit_id": "string",
        "protection_info": {
          "inheriting_entity_id": "string",
          "inheriting_entity_type": "string",
          "policy_id": "string"
        },
        "status": "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 Availability Groups​

List Availability Groups