Skip to main content

Retrieve a Host

Returns a representation of the specified host.

Path Parameters
  • host_id string required

    Performs the operation on a host within the specified host id.

Responses

Success


Schema
  • _embedded object

    Embedded responses related to the resource.

  • _links object

    EC2MSSQLInvHostLinks contains links related to ec2 mssql host 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.

  • account_native_id string

    The AWS-assigned ID of the account associated with the EC2 instance of the MSSQL host.

  • aws_region string

    The AWS region associated with the EC2 instance of the MSSQL host.

  • connection_id string

    The Clumio-assigned ID of the host connection.

  • endpoint string

    The user-provided endpoint of the host containing the given database.

  • environment_id string

    The Clumio-assigned ID of the AWS environment associated with the EC2 MSSQL host.

  • has_associated_availability_group boolean

    Determines whether or not an availability group is present in the host.

  • id string

    The Clumio-assigned ID of the Host.

  • instance_count int64

    The number of instances present in the host.

  • is_part_of_fci boolean

    IsPartOfFCI is a boolean field representing if the Host is part of Failover Cluster

  • organizational_unit_id string

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

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

  • status string

    The status of the Host, Possible values include 'active' and 'inactive'.

GET /datasources/aws/ec2-mssql/hosts/:host_id    

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
host_id — path required
curl -L -X GET 'https://us-west-2.api.clumio.com/datasources/aws/ec2-mssql/hosts/:host_id' \
-H 'Accept: application/api.clumio.ec2-mssql-hosts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'