Queries the full status information of one or more instances. The full status information includes the instance status and the instance event status. The instance status is the lifecycle status of the instance. The instance event status is the health status of the maintenance event. For more information, see ECS instance lifecycle and System events.

Description

The response includes the status information about the instance and the scheduled system events.

If a period is specified, all the events in the period are queried.

Debugging

You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Name Type Required Example Description
RegionId String Yes cn-hangzhou

The ID of the region where the instance is located. You can call DescribeRegions to view the latest regions of Alibaba Cloud.

Action String No DescribeInstancesFullStatus

The operation that you want to perform. Set the value to DescribeInstancesFullStatus.

EventId.N RepeatList No [EventId. 1="e-xhskHun1256xxxx",EventId. 2="e-xhskHun1257xxxx"……]

The IDs of one or more events. Valid values of N: 1 to 100. You can specify multiple values in the form of a repeated list.

EventPublishTime.End String No 2017-12-07T00:00:00Z

The end time of the period during which a system event is pushed. The time follows the ISO 8601 standard and uses UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.

EventPublishTime.Start String No 2017-11-30T00:00:00Z

The start time of the period during which a system event is pushed. The time follows the ISO 8601 standard and uses UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.

EventType String No InstanceExpiration.Stop

The type of the event. The EventType parameter takes effect only when the InstanceEventType.N parameter is not specified. Valid values:

  • SystemMaintenance.Reboot: The instance restarts due to maintenance.
  • SystemFailure.Reboot: The instance restarts due to a system failure.
  • InstanceFailure.Reboot: The instance restarts due to an instance failure.
  • InstanceExpiration.Stop: The instance is stopped due to subscription expiration.
  • InstanceExpiration.Delete: The instance is released due to subscription expiration.
  • AccountUnbalanced.Stop: The instance is stopped due to overdue payments.
  • AccountUnbalanced.Delete: The instance is released due to overdue payments.
HealthStatus String No Maintaining

The health status of the instance. Valid values:

  • Impaired: The instance is impaired.
  • Warning: The instance performance may be degraded because of maintenance or technical issues.
  • Maintaining: The instance is in maintenance.
  • Initializing: The instance is in initialization.
  • InsufficientData: The status cannot be determined because of insufficient data.
  • NotApplicable: Not applicable.

All the values are case-sensitive.

InstanceEventType.N RepeatList No InstanceExpiration.Stop

The types of one or more events. Valid values of N: 1 to 30. You can specify multiple values in the form of a repeated list. Valid values:

  • SystemMaintenance.Reboot: The instance restarts due to maintenance.
  • SystemFailure.Reboot: The instance restarts due to a system failure.
  • InstanceFailure.Reboot: The instance restarts due to an instance failure.
  • InstanceExpiration.Stop: The instance is stopped due to subscription expiration.
  • InstanceExpiration.Delete: The instance is released due to subscription expiration.
  • AccountUnbalanced.Stop: The instance is stopped due to overdue payments.
  • AccountUnbalanced.Delete: The instance is released due to overdue payments.
InstanceId.N RepeatList No [InstanceId. 1="i-instance1",InstanceId. 2="i-instance2"……]

The IDs of one or more instances. Valid values of N: 1 to 100. You can specify multiple values in the form of a repeated list.

NotBefore.End String No 2017-11-30T00:00:00Z

The end time of the scheduled event execution period. The time follows the ISO 8601 standard and uses UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.

NotBefore.Start String No 2017-12-07T00:00:00Z

The start time of the scheduled event execution period. The time follows the ISO 8601 standard and uses UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.

PageNumber Integer No 1

The page number of the query result. The value must be a positive integer.

Default value: 1.

PageSize Integer No 10

The number of entries per page. Valid values: 1 to 100.

Default value: 10.

Status String No Running

The lifecycle status of the specified instance. Valid values:

  • Starting
  • Running
  • Stopped

Response parameters

Name Type Example Description
InstanceFullStatusSet

An array of InstanceFullStatus data.

 └HealthStatus

The health status of the instance.

 └Code Integer 64

The code of the health status.

 └Name String Warning

The name of the health status.

 └InstanceId String i-instance1

The ID of the instance.

 └ScheduledSystemEventSet

An array of ScheduledSystemEvent data.

 └EventCycleStatus

The event status.

 └Code Integer 24

The code of the event status.

 └Name String Scheduled

The name of the event status.

 └EventId String e-event1

The ID of the instance event.

 └EventPublishTime String 2017-11-30T06:32:31Z

The publishing time of the event. The time follows the ISO 8601 standard and uses UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.

 └EventType

The event type.

 └Code Integer 1

The code of the event type.

 └Name String SystemMaintenance.Reboot

The name of the event type.

 └ExtendedAttribute

The extended attribute of system events for instances with local disks.

 └Device String /dev/vdb

The device name of the local disk.

 └DiskId String d-diskid2

The ID of the local disk.

 └NotBefore String 2017-12-07T00:00:00Z

The scheduled execution time of the event. The time follows the ISO 8601 standard and uses UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.

 └Status

The instance lifecycle status.

 └Code Integer 1

The code of the instance lifecycle status.

 └Name String Running

The name of the instance lifecycle status.

PageNumber Integer 1

The page number.

PageSize Integer 10

The number of entries per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 2

The total number of entries.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeInstancesFullStatus
&RegionId=cn-hangzhou 
&InstanceId.1=i-instance1
&EventId.1=e-event1
&Status=Running
&HealthStatus=Maintaining 
&InstanceEventType.1=InstanceExpiration.Stop
&EventType=InstanceExpiration.Stop
&NotBefore.Start=2017-12-07T00:00:00Z
&NotBefore.End=2017-11-30T00:00:00Z 
&EventPublishTime.Start=2017-11-30T00:00:00Z 
&EventPublishTime.End=2017-12-07T00:00:00Z
&PageNumber=1 
&PageSize=10 
&<Common request parameters>

Successful response examples

XML format

<DescribeInstancesFullStatusResponse>
    <InstanceFullStatusSet>
        <InstanceFullStatusType>
            <InstanceId>i-instance1</InstanceId>
            <Status>
                <Code>1</Code>
                <Name>Running</Name>
            </Status>
            <HealthStatus>
                <Code>0</Code>
                <Name>Maintaining</Name>
            </HealthStatus>
            <ScheduledSystemEventSet>
                <ScheduledSystemEventType>
                    <EventId>e-event1</EventId>
                    <EventCycleStatus>
                        <Code>24</Code>
                        <Name>Scheduled</Name>
                    </EventCycleStatus>
                    <EventType>
                        <Code>1</Code>
                        <Name>SystemMaintenance.Reboot</Name>
                    </EventType>
                    <EventPublishTime>2017-11-30T06:32:31Z</EventPublishTime>
                    <NotBefore>2017-12-01T06:32:31Z</NotBefore>
                </ScheduledSystemEventType>
                <ScheduledSystemEventType>
                    <EventId>e-event2</EventId>
                    <EventCycleStatus>
                        <Code>24</Code>
                        <Name>Scheduled</Name>
                    </EventCycleStatus> 
                    <EventType>
                        <Code>34</Code>
                        <Name>InstanceExpiration.Stop</Name>
                    </EventType>
                    <EventPublishTime>2017-11-30T00:00:00Z</EventPublishTime>
                    <NotBefore>2017-12-07T00:00:00Z</NotBefore>
                </ScheduledSystemEventType>
            </ScheduledSystemEventSet>
        </InstanceFullStatusType>
        <InstanceFullStatusType> 
            <InstanceId>i-instance2</InstanceId>
            <Status> 
                <Code>1</Code>
                <Name>Running</Name>
            </Status>
            <HealthStatus>
                <Code>64</Code>
                <Name>Warning</Name>
            </HealthStatus>
            <ScheduledSystemEventSet>
                <ScheduledSystemEventType>
                    <EventId>e-event3</EventId>
                    <EventCycleStatus>
                        <Code>24</Code>
                        <Name>Scheduled</Name>
                    </EventCycleStatus>
                    <EventType>
                        <Code>65</Code> 
                        <Name>SystemFailure.Reboot</Name>
                    </EventType>
                    <EventPublishTime>2017-11-30T06:32:31Z</EventPublishTime>
                    <NotBefore>2017-12-01T06:32:31Z</NotBefore>
                </ScheduledSystemEventType>
            </ScheduledSystemEventSet>
        </InstanceFullStatusType>
    </InstanceFullStatusSet>
    <PageSize>10</PageSize> 
    <PageNumber>1</PageNumber> 
    <TotalCount>2</TotalCount> 
    <RequestId>AAC49D3E-ED6F-4F00-XXXX-377C551B1DD4</RequestId>
</DescribeInstancesFullStatusResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":2,
	"PageSize":10,
	"InstanceFullStatusSet":{
		"InstanceFullStatusType":[
			{
				"Status":{
					"Name":"Running",
					"Code":1
				},
				"HealthStatus":{
					"Name":"Maintaining",
					"Code":0
				},
				"InstanceId":"i-instance1",
				"ScheduledSystemEventSet":{
					"ScheduledSystemEventType":[
						{
							"EventPublishTime":"2017-11-30T06:32:31Z",
							"NotBefore":"2017-12-01T06:32:31Z",
							"EventId":"e-event1",
							"EventType":{
								"Name":"SystemMaintenance.Reboot",
								"Code":1
							},
							"EventCycleStatus":{
								"Name":"Scheduled",
								"Code":24
							}
						},
						{
							"EventPublishTime":"2017-11-30T00:00:00Z",
							"NotBefore":"2017-12-07T00:00:00Z",
							"EventId":"e-event2",
							"EventType":{
								"Name":"InstanceExpiration.Stop",
								"Code":34
							},
							"EventCycleStatus":{
								"Name":"Scheduled",
								"Code":24
							}
						}
					]
				}
			},
			{
				"Status":{
					"Name":"Running",
					"Code":1
				},
				"HealthStatus":{
					"Name":"Warning",
					"Code":64
				},
				"InstanceId":"i-instance2",
				"ScheduledSystemEventSet":{
					"ScheduledSystemEventType":[
						{
							"EventPublishTime":"2017-11-30T06:32:31Z",
							"NotBefore":"2017-12-01T06:32:31Z",
							"EventId":"e-event3",
							"EventType":{
								"Name":"SystemFailure.Reboot",
								"Code":65
							},
							"EventCycleStatus":{
								"Name":"Scheduled",
								"Code":24
							}
						}
					]
				}
			}
		]
	},
	"RequestId":"AAC49D3E-ED6F-4F00-XXXX-377C551B1DD4"
}

Error codes

HTTP status code Error code Error message Description
404 MissingParameter %s The error message returned when a required parameter is not specified.
403 InvalidParameter %s The error message returned when the parameter format is invalid.
403 InvalidParameter.TimeEndBeforeStart %s The error message returned when the end time is earlier than the start time.
403 OperationDenied.NotInWhiteList %s The error message returned when you are not authorized to perform the operation.
403 InstanceIdLimitExceeded %s The error message returned when the specified instance IDs is more than 100.
403 EventIdLimitExceeded %s The error message returned when more than 100 simulated event IDs are specified.

View error codes