DescribeInstancesFullStatus-阿里云帮助中心

Queries the full status information of one or more Elastic Compute Service (ECS) instances. The full status information includes ECS instance status and ECS instance system event status. ECS instance status indicates the lifecycle status of ECS instance, and ECS instance system event status indicates the health status of maintenance events.

Operation description

The response includes the instance status and instance system events in the Scheduled state.

If a time period is specified, events are filtered based on the time period.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeInstancesFullStatus

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Status	string	No	The lifecycle status of the instance. Valid values: Starting: The instance is being started. Running: The instance is running. Stopped: The instance is stopped.	Running
HealthStatus	string	No	The health status of the instance. Valid values: Impaired: The service is damaged. Warning: A warning is issued. Instance performance may be degraded due to maintenance. Maintaining: The instance is being maintained. Initializing: The instance is being initialized. InsufficientData: Data is insufficient. NotApplicable: Not applicable. The values are case-sensitive.	Initializing
EventType	string	No	The type of the event. The EventType parameter is valid only when the InstanceEventType.N parameter 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 failure. InstanceFailure.Reboot: The instance is restarted due to an instance failure. 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.	InstanceExpiration.Stop
NotBefore.Start	string	No	The start time of the scheduled execution time of the event. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. ISO 8601	2017-12-07T00:00:00Z
NotBefore.End	string	No	The end time of the scheduled execution time of the event. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. ISO 8601	2017-11-30T00:00:00Z
EventPublishTime.Start	string	No	The start time of the event publication time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. ISO 8601	2017-11-30T00:00:00Z
EventPublishTime.End	string	No	The end time of the event publication time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. ISO 8601	2017-12-07T00:00:00Z
PageNumber	integer	No	The page number of the query result. Valid values: positive integers. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
InstanceId	array	No	The list of instance IDs. You can specify up to 100 instance IDs.	i-bp67acfmxazb4p****
	string	No	The instance ID.	i-bp67acfmxazb4p****
EventId	array	No	The list of event IDs. You can specify up to 100 event IDs.	e-bp1hygp5b04o56l0****
	string	No	The event ID.	e-bp1hygp5b04o56l0****
InstanceEventType	array	No	The list of instance event types. You can specify up to 30 instance event types.	InstanceExpiration.Stop
	string	No	The type of the instance 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 failure. SystemFailure.Redeploy: The instance is redeployed due to a system failure. SystemFailure.Delete: The instance is released due to a creation failure. InstanceFailure.Reboot: The instance is restarted due to an instance failure. 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 about event types, see Overview of system events. The value of this parameter can only be an instance system event, not a disk system event.	SystemMaintenance.Reboot

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	1
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	2
InstanceFullStatusSet	object
InstanceFullStatusType	array<object>	The array of the full status of the instance. Note This parameter is empty if the instance does not exist.
	array<object>
InstanceId	string	The instance ID.	i-bp67acfmxazb4p****
ScheduledSystemEventSet	object
ScheduledSystemEventType	array<object>	The array of system events whose current status is Scheduled or Inquiring.
	array<object>
EventPublishTime	string	The publication time of the event. The time is in UTC.	2017-11-30T06:32:31Z
EventId	string	The ID of the instance event.	e-bp1hygp5b04o56l0****
NotBefore	string	The scheduled execution time of the event. The time is in UTC.	2017-12-07T00:00:00Z
ImpactLevel	string	The impact level. Note This parameter is empty for users who are not in the whitelist.	100
Reason	string	The planned cause of the system event. Note This parameter is empty if Alibaba Cloud has not identified the cause of the exception.	A simulated event.
EventCycleStatus	object	The status of the event.
Name	string	The name of the event status.	Scheduled
Code	integer	The status code of the event.	24
EventType	object	The event type.
Name	string	The name of the event type.	SystemMaintenance.Reboot
Code	integer	The code of the event type.	1
ExtendedAttribute	object	The extended attributes of the system event for an instance with local disks. The returned values vary based on the event type. This parameter is empty if the event type is not in the following list: SystemMaintenance.StopAndRepair SystemMaintenance.CleanInactiveDisks SecurityPunish.Locked SecurityPunish.WebsiteBanned SystemUpgrade.Migrate SystemMaintenance.RebootAndIsolateErrorDisk SystemMaintenance.RebootAndReInitErrorDisk SystemMaintenance.ReInitErrorDisk SystemMaintenance.IsolateErrorDisk
Device	string	The device name of the local disk.	/dev/vdb
DiskId	string	The ID of the local disk.	d-bp67acfmxazb4p****
InactiveDisks	object
InactiveDisk	array<object>	The information about inactive cloud disks or local disks that have been released but need to be cleaned up.
	object
CreationTime	string	The time when the disk or local disk was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-07-27T13:53:25Z
DeviceSize	string	The size of the disk or local disk, in GiB.	80
DeviceCategory	string	The category of the disk or local disk. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: enterprise SSD local_ssd_pro: I/O-intensive local disk local_hdd_pro: throughput-intensive local disk ephemeral: (retired) local disk ephemeral_ssd: (retired) local SSD	cloud_ssd
DeviceType	string	The type of the disk or local disk. Valid values: system: system disk data: data disk	system
ReleaseTime	string	The time when the disk or local disk was released. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-07-27T13:53:25Z
Status	object	The instance lifecycle epoch status.
Name	string	The name of the instance lifecycle epoch status.	Running
Code	integer	The status code of the instance lifecycle epoch.	1
HealthStatus	object	The health status of the instance.
Name	string	The name of the health status.	Warning
Code	integer	The status code of the health status.	64

Examples

Success response

JSON format

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "InstanceFullStatusSet": {
    "InstanceFullStatusType": [
      {
        "InstanceId": "i-bp67acfmxazb4p****",
        "ScheduledSystemEventSet": {
          "ScheduledSystemEventType": [
            {
              "EventPublishTime": "2017-11-30T06:32:31Z",
              "EventId": "e-bp1hygp5b04o56l0****",
              "NotBefore": "2017-12-07T00:00:00Z",
              "ImpactLevel": "100",
              "Reason": "A simulated event.",
              "EventCycleStatus": {
                "Name": "Scheduled",
                "Code": 24
              },
              "EventType": {
                "Name": "SystemMaintenance.Reboot",
                "Code": 1
              },
              "ExtendedAttribute": {
                "Device": "/dev/vdb",
                "DiskId": "d-bp67acfmxazb4p****",
                "InactiveDisks": {
                  "InactiveDisk": [
                    {
                      "CreationTime": "2018-07-27T13:53:25Z",
                      "DeviceSize": "80",
                      "DeviceCategory": "cloud_ssd",
                      "DeviceType": "system",
                      "ReleaseTime": "2019-07-27T13:53:25Z"
                    }
                  ]
                }
              }
            }
          ]
        },
        "Status": {
          "Name": "Running",
          "Code": 1
        },
        "HealthStatus": {
          "Name": "Warning",
          "Code": 64
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter	%s
403	InvalidParameter.TimeEndBeforeStart	%s	The specified parameter is invalid. 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 when you are authorized.
403	InstanceIdLimitExceeded	%s	More than 100 instance IDs are specified.
403	EventIdLimitExceeded	%s
404	MissingParameter	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.