List availability groups

get deprecatedhttps://{region}.api.clumio.com/datasources/mssql/availability-groups

Returns a list of Microsoft SQL Server availability groups.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

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.
group_id	$eq	Filter availability groups where given string is a equal to the group_id.
subgroup_id	$eq	Filter availability groups where given string is a equal to the subgroup_id.
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 Group whose status is equal to the given string.

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

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

items

array of objects

A collection of requested items.

items

object

_embedded

object

Embedded responses related to the resource.

_links

object

URLs to pages related to the resource.

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.

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.

_last

object

The HATEOAS link to the last page of results.

_next

object

The HATEOAS link to the next page of results.

_prev

object

The HATEOAS link to the previous page of results.

_self

object

The HATEOAS link to this resource.

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.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/datasources/mssql/availability-groups \
3
     --header 'accept: application/api.clumio.mssql-availability-groups=v1+json'


xxxxxxxxxx
63
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "_embedded": {},
6
        "_links": {
7
          "_self": {
8
            "href": "string",
9
            "templated": true,
10
            "type": "string"
11
          },
12
          "read-policy-definition": {
13
            "href": "string",
14
            "templated": true,
15
            "type": "string"
16
          }
17
        },
18
        "id": "string",
19
        "name": "string",
20
        "organizational_unit_id": "string",
21
        "protection_info": {
22
          "inheriting_entity_id": "string",
23
          "inheriting_entity_type": "string",
24
          "policy_id": "string"
25
        },

200200 HTTP success response

defaultError