Usage notes

The response includes instance states and instance system events that are in the Scheduled state.

You can specify a period of time to query events that occurred within the period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeInstancesFullStatus	The operation that you want to perform. Set the value to DescribeInstancesFullStatus.
RegionId	String	Yes	cn-hangzhou	The region ID. You can call the DescribeRegions operation to query the most recent region list.
Status	String	No	Running	The lifecycle state of the instance. Valid values: Starting Running Stopped
HealthStatus	String	No	OK	The health state of the instance. Valid values: OK Impaired Initializing InsufficientData NotApplicable All the values are case-sensitive.
EventType	String	No	InstanceExpiration.Stop	The type of the system event. This parameter is valid only when InstanceEventType.N is not specified. Valid values: SystemMaintenance.Reboot: The instance is restarted due to system maintenance. SystemFailure.Reboot: The instance is restarted due to a system error. InstanceFailure.Reboot: The instance is restarted due to an instance error. InstanceExpiration.Stop: The subscription instance is stopped due to expiration. InstanceExpiration.Delete: The subscription instance is released due to expiration. AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment. AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment.
NotBefore.Start	String	No	2017-12-07T00:00:00Z	The beginning of the time range during which O&M tasks related to scheduled system events are executed. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.
NotBefore.End	String	No	2017-11-30T00:00:00Z	The end of the time range during which O&M tasks related to scheduled system events are executed. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.
EventPublishTime.Start	String	No	2017-11-30T00:00:00Z	The beginning of the time range during which system events are published. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.
EventPublishTime.End	String	No	2017-12-07T00:00:00Z	The end of the time range during which system events are published. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.
PageNumber	Integer	No	1	The page number. 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.
InstanceId.N	String	No	i-bp67acfmxazb4p****	The instance ID.
EventId.N	String	No	e-bp1hygp5b04o56l0****	The system event ID.
InstanceEventType.N	String	No	SystemMaintenance.Reboot	The type of the system event. Valid values: SystemMaintenance.Reboot: The instance is restarted due to system maintenance. SystemMaintenance.Redeploy: The instance is redeployed due to system maintenance. SystemFailure.Reboot: The instance is restarted due to a system error. SystemFailure.Redeploy: The instance is redeployed due to a system error. SystemFailure.Delete: The instance is released due to an instance creation failure. InstanceFailure.Reboot: The instance is restarted due to an instance error. InstanceExpiration.Stop: The subscription instance is stopped due to expiration. InstanceExpiration.Delete: The subscription instance is released due to expiration. AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment. AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment. Note For more information, see Overview. The values of this parameter are applicable only to instance system events, not to disk system events.

Response parameters

Parameter	Type	Example	Description
PageSize	Integer	1	The number of entries per page.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	The request ID.
PageNumber	Integer	1	The page number.
TotalCount	Integer	2	The total number of entries.
InstanceFullStatusSet	Array of InstanceFullStatusType		The queried instances. Note If no instances exist, this parameter is empty.
InstanceFullStatusType
InstanceId	String	i-bp67acfmxazb4p****	The instance ID.
ScheduledSystemEventSet	Array of ScheduledSystemEventType		The system events that are in the Scheduled or Inquiring state.
ScheduledSystemEventType
EventPublishTime	String	2017-11-30T06:32:31Z	The time when the system event was published. The time is displayed in UTC.
EventId	String	e-bp1hygp5b04o56l0****	The system event ID.
NotBefore	String	2017-12-07T00:00:00Z	The scheduled time at which to execute the O&M task related to the system event. The time is displayed in UTC.
ImpactLevel	String	100	The impact level of the system event. Note If the user is not in a whitelist, this parameter is empty.
Reason	String	A simulated event.	The reason why the system event was scheduled. Note If the exception reason is not detected, this parameter is empty.
EventCycleStatus	Object		The state of the system event.
Name	String	Scheduled	The name of the system event state.
Code	Integer	24	The code of the system event state.
EventType	Object		The type of the system event.
Name	String	SystemMaintenance.Reboot	The name of the system event type.
Code	Integer	1	The code of the system event type.
ExtendedAttribute	Object		The extended attributes of system events generated for instances that have local disks attached. The return values are different for each event type. If the system event type is not any of the following values, this parameter is empty. SystemMaintenance.StopAndRepair SystemMaintenance.CleanInactiveDisks SecurityPunish.Locked SecurityPunish.WebsiteBanned SystemUpgrade.Migrate SystemMaintenance.RebootAndIsolateErrorDisk SystemMaintenance.RebootAndReInitErrorDisk SystemMaintenance.ReInitErrorDisk SystemMaintenance.IsolateErrorDisk
Device	String	/dev/vdb	The device name of the local disk.
DiskId	String	d-bp67acfmxazb4p****	The ID of the local disk.
InactiveDisks	Array of InactiveDisk		The inactive disks that have been released and must be cleared.
InactiveDisk
CreationTime	String	2018-07-27T13:53:25Z	The time when the disk was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
DeviceSize	String	80	The size of the disk. Unit: GiB.
DeviceCategory	String	cloud_ssd	The category of the disk. Valid values: cloud: basic disk cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: enhanced SSD (ESSD). local_ssd_pro: I/O-intensive local disk. local_hdd_pro: throughput-intensive local disk. ephemeral: retired local disk. ephemeral_ssd: retired local SSD.
DeviceType	String	system	The type of the disk. Valid values: system data
ReleaseTime	String	2019-07-27T13:53:25Z	The time when the disk was released. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
Status	Object		The lifecycle state of the instance.
Name	String	Running	The name of the instance lifecycle state.
Code	Integer	1	The code of the instance lifecycle state.
HealthStatus	Object		The health state of the instance.
Name	String	Warning	The name of the health state.
Code	Integer	64	The code of the health state.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=DescribeInstancesFullStatus
&RegionId=cn-hangzhou
&InstanceId.1=i-bp67acfmxazb4p****
&EventId.1=e-bp1hygp5b04o56l0****
&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=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstancesFullStatusResponse>
    <TotalCount>1</TotalCount>
    <RequestId>7EBCB534-1CE5-46E7-92A6-507B1654CC03</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <InstanceFullStatusSet>
        <InstanceFullStatusType>
            <Status>
                <Code>1</Code>
                <Name>Running</Name>
            </Status>
            <InstanceId>i-bp19cx17f2yx****</InstanceId>
            <HealthStatus>
                <Code>64</Code>
                <Name>Warning</Name>
            </HealthStatus>
            <ScheduledSystemEventSet>
                <ScheduledSystemEventType>
                    <EventCycleStatus>
                        <Code>24</Code>
                        <Name>Scheduled</Name>
                    </EventCycleStatus>
                    <EventPublishTime>2020-04-24T07:09:37Z</EventPublishTime>
                    <EventType>
                        <Code>65</Code>
                        <Name>SystemFailure.Reboot</Name>
                    </EventType>
                    <ExtendedAttribute/>
                    <EventId>e-bp1hygp5b04o56l0****</EventId>
                    <NotBefore>2020-04-24T10:32:31Z</NotBefore>
                    <Reason>A simulated event.</Reason>
                </ScheduledSystemEventType>
            </ScheduledSystemEventSet>
        </InstanceFullStatusType>
    </InstanceFullStatusSet>
</DescribeInstancesFullStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "7EBCB534-1CE5-46E7-92A6-507B1654CC03",
  "PageSize" : 10,
  "PageNumber" : 1,
  "InstanceFullStatusSet" : {
    "InstanceFullStatusType" : [ {
      "Status" : {
        "Code" : 1,
        "Name" : "Running"
      },
      "InstanceId" : "i-bp19cx17f2yx****",
      "HealthStatus" : {
        "Code" : 64,
        "Name" : "Warning"
      },
      "ScheduledSystemEventSet" : {
        "ScheduledSystemEventType" : [ {
          "EventCycleStatus" : {
            "Code" : 24,
            "Name" : "Scheduled"
          },
          "EventPublishTime" : "2020-04-24T07:09:37Z",
          "EventType" : {
            "Code" : 65,
            "Name" : "SystemFailure.Reboot"
          },
          "ExtendedAttribute" : { },
          "EventId" : "e-bp1hygp5b04o56l0****",
          "NotBefore" : "2020-04-24T10:32:31Z",
          "Reason" : "A simulated event."
        } ]
      }
    } ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter	%s	Invalid parameter.
403	InvalidParameter.TimeEndBeforeStart	%s	Invalid parameter. Make sure that the end time is later than the start time.
403	OperationDenied.NotInWhiteList	%s	You are not authorized to perform this operation. Try again after you are authorized.
403	InstanceIdLimitExceeded	%s	More than 100 instance IDs are specified.
403	EventIdLimitExceeded	%s	More than 100 event IDs are specified.
404	MissingParameter	%s	A parameter is not specified.

For a list of error codes, see Service error codes.