Skip to main content

Retrieve the list of Failover clusters​

Returns a list of failover clusters.

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:

    FieldFilter ConditionDescription
    name$containsFilter fci based on the name of the cluster.
    environment_id$eqFilter fci based on the environment ID.
    protection_info.policy_id$eqFilter fci based on the policy id
    protection_status$eqFilter fci whose protection status is equal to the given string.
    account_ids$inFilter FCIs 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 LinkDescription
    read-policy-definitionEmbeds 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-failover-cluster-statsEmbeds the stats information associated with failover cluster. For example, ?embed=get-ec2-mssql-failover-cluster-stats.
    get-ec2-mssql-failover-cluster-hosts-infoEmbeds the stats information associated with Hosts part of failover cluster. For example, ?embed=get-ec2-mssql-failover-cluster-hosts-info.
    get-ec2-mssql-stats-backup-statusEmbeds 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

Success

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-cluster-backup-status-stats

    FCIBackupStatusStats contain information about the backup status of the databases in the cluster

  • get-ec2-mssql-failover-cluster-hosts-info

    ConnectedHostsInfo contains information about the hosts associated with the cluster

  • get-ec2-mssql-failover-cluster-stats

    FCIStats contain information about the compliant databases in the cluster

  • 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.

  • 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 failover cluster.

  • name string

    The Microsoft SQL-assigned name of the failover cluster.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the FCI.

  • 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.

  • protection_status string

    ProtectionStatus of the FCI

  • status string

    The status of the FCI, 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.

Loading...