DescribeInstanceStatus

GET /?Action=DescribeInstanceStatus
Description

Describes the status of one or more instances.
You can use the Filter.N parameter to filter the described instances status on the following properties:

  • availability-zone: The Availability Zone of the instance.

  • event.code: The code for the scheduled event (system-reboot | system-maintenance).

  • event.description: The description of the scheduled event.

  • instance-state-code: The state of the instance (a 16-bit unsigned integer). The high byte is an internal value you should ignore. The low byte represents the state of the instance: -1 (quarantine), 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name: The state of the instance (pending | running | stopping | stopped | shutting-down | terminated | quarantine).

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeInstanceStatusRequest

Name Description Required Schema Default Example

Filter.N

One or more filters. Example:
osc-cli fcu DescribeInstanceStatus \
  --Filter.1.Name "availability-zone" \
  --Filter.1.Value.1 "eu-west-2a"

false

Filter

IncludeAllInstances

If set to true, includes the status of all instances. By default or if set to false, only includes the status of running instances.

false

boolean

InstanceId.N

One or more instance IDs.

false

string

MaxResults

The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between 5 and 1000.
If you provide a value larger than 1000, only 1000 results are returned. You cannot specify both this parameter and the InstanceId parameter in the same request.

false

integer

NextToken

The token to request the next results page.

false

integer
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeInstanceStatusResult

Response 200

Response 200

Name Description Required Schema Default Example

instanceStatusSet.N

One or more instance status descriptions.

false

InstanceStatus

nextToken

The token to request the next results page. If the value is null, there is no results left to be returned.

false

string

requestId

The ID of the request.

false

string