Skip to main content

Retrieve an Instance​

Returns a representation of the specified instance.

Path Parameters
  • instance_id string required

    Performs the operation on the instance with the specified ID.

Responses

Success

Schema
  • _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 TypeDetails
    aws_tagAWS 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'.

Loading...