List Instances

Returns a list of Instances

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 Instance where given string is a substring of the name.
environment_id	$eq	The Clumio-assigned ID of the AWS environment.
host_id	$eq	Filter Instance where given string is equal to the host_id.
protection_info.policy_id	$eq	Filter Instance whose policy_id is equal to the given string.
protection_status	$eq	Filter Instance whose protection_status is equal to the given string.
status	$eq	Filter Instances whose status is equal to the given string.

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

Responses

200
default

Success

application/api.clumio.ec2-mssql-instance=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-ec2-mssql-instance-backup-status-stats
Stats pertaining to the backup status of the EC2 MSSQL Instance.
get-ec2-mssql-instance-stats
Stats pertaining to the EC2 MSSQL Instance.
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.
account_native_id string
The AWS-assigned ID of the account associated with the EC2 instance of the MSSQL instance.
aws_region string
The AWS region associated with the EC2 instance of the MSSQL instance.
environment_id string
The Clumio-assigned ID of the AWS environment associated with the EC2 MSSQL instance.
has_associated_availability_group boolean
The boolean value represents if availability group is present in the instance.
host_connection_id string
The Clumio-assigned ID of the host connection containing the given mssql instance.
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 instance.
id string
The Clumio-assigned ID of the Instance.
name string
The Microsoft SQL assigned name of the instance.
organizational_unit_id string
The Clumio-assigned ID of the organizational unit associated with the instance.
product_version string
Product Version of the instance.
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.
server_name string
The Microsoft SQL assigned server name of the instance.
status string
The status of the Instance, 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"
          },
          "read-policy-definition": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "account_native_id": "string",
        "aws_region": "string",
        "environment_id": "string",
        "has_associated_availability_group": true,
        "host_connection_id": "string",
        "host_endpoint": "string",
        "host_id": "string",
        "id": "string",
        "name": "string",
        "organizational_unit_id": "string",
        "product_version": "string",
        "protection_info": {
          "inheriting_entity_id": "string",
          "inheriting_entity_type": "string",
          "policy_id": "string"
        },
        "server_name": "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"
    }
  ]
}

GET /datasources/aws/ec2-mssql/instances

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

limit — query

start — query

filter — query

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/instances' \
-H 'Accept: application/api.clumio.ec2-mssql-instance=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/instances' \
-H 'Accept: application/api.clumio.ec2-mssql-instance=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/instances' \
-H 'Accept: application/api.clumio.ec2-mssql-instance=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/instances' \
-H 'Accept: application/api.clumio.ec2-mssql-instance=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/instances' \
-H 'Accept: application/api.clumio.ec2-mssql-instance=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/instances' \
-H 'Accept: application/api.clumio.ec2-mssql-instance=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/instances' \
-H 'Accept: application/api.clumio.ec2-mssql-instance=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

List Instances​

Authorization

Request

List Instances