DescribeInstancesFullStatus-阿里云帮助中心

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

Operation description

Usage notes

The response includes the instance status and the 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.

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
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 Running Stopped	Running
HealthStatus	string	No	The health status of the instance. Valid values: Impaired Warning: The instance performance may be degraded due to maintenance or technical issues. Maintaining Initializing InsufficientData NotApplicable All the values are case-sensitive.	Initializing
EventType	string	No	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 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 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.	2017-12-07T00:00:00Z
NotBefore.End	string	No	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.	2017-11-30T00:00:00Z
EventPublishTime.Start	string	No	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.	2017-11-30T00:00:00Z
EventPublishTime.End	string	No	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.	2017-12-07T00:00:00Z
PageNumber	integer	No	The page number. The value must be a positive integer. 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 IDs of the instances. You can specify up to 100 instance IDs in a single request.	i-bp67acfmxazb4p****
	string	No	The ID of instance N.	i-bp67acfmxazb4p****
EventId	array	No	The IDs of the system events. You can specify up to 100 event IDs in a single request.	e-bp1hygp5b04o56l0****
	string	No	The ID of the system event.	e-bp1hygp5b04o56l0****
InstanceEventType	array	No	The types of system events. You can specify up to 30 event types in a single request.	InstanceExpiration.Stop
	string	No	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, but not to disk system events.	SystemMaintenance.Reboot

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	1
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	2
InstanceFullStatusSet	object
InstanceFullStatusType	array<object>	The queried instances. Note If no instances exist, this parameter is empty.
	array<object>
InstanceId	string	The instance ID.	i-bp67acfmxazb4p****
ScheduledSystemEventSet	object
ScheduledSystemEventType	array<object>	The system events that are in the Scheduled or Inquiring state.
	array<object>
EventPublishTime	string	The time when the system event was published. The time is displayed in UTC.	2017-11-30T06:32:31Z
EventId	string	The system event ID.	e-bp1hygp5b04o56l0****
NotBefore	string	The scheduled time at which to execute the O&M task related to the system event. The time is displayed in UTC.	2017-12-07T00:00:00Z
ImpactLevel	string	The impact level of the system event. Note If the user is not in a whitelist, this parameter is empty.	100
Reason	string	The reason why the system event was scheduled. Note If the exception cause is not detected, this parameter is empty.	A simulated event.
EventCycleStatus	object	The state of the system event.
Name	string	The name of the system event state.	Scheduled
Code	integer	The code of the system event state.	24
EventType	object	The type of the system event.
Name	string	The name of the system event type.	SystemMaintenance.Reboot
Code	integer	The code of the system event type.	1
ExtendedAttribute	object	The extended attributes of system events generated for instances that have local disks attached. The return values vary based on the system event type. If the system event type is not one of the following types, this parameter is empty: 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 inactive disks that have been released and must be cleared.
	object
CreationTime	string	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.	2018-07-27T13:53:25Z
DeviceSize	string	The size of the disk. Unit: GiB.	80
DeviceCategory	string	The category of the disk. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: Enterprise 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	cloud_ssd
DeviceType	string	The type of the disk. Valid values: system data	system
ReleaseTime	string	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.	2019-07-27T13:53:25Z
Status	object	The lifecycle state of the instance.
Name	string	The name of the instance lifecycle state.	Running
Code	integer	The code of the instance lifecycle state.	1
HealthStatus	object	The health state of the instance.
Name	string	The name of the health state.	Warning
Code	integer	The code of the health state.	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 response

JSON format

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

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.