All Products
Search
Document Center

Elastic Compute Service:DescribeInstancesFullStatus

Last Updated:Mar 13, 2024

Queries the full status information of Elastic Compute Service (ECS) instances. The full status information includes instance states and system event states. The instance states are the lifecycle states of instances. The system event states are the health states of maintenance events that occur on ECS instances.

Operation description

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
StatusstringNo

The lifecycle state of the instance. Valid values:

  • Starting: The instance is being started.
  • Running: The instance is running.
  • Stopped: The instance is stopped.
Running
HealthStatusstringNo

The health state of the instance. Valid values:

  • Impaired: The instance is impaired.
  • Warning: The performance of the instance is degraded.
  • Maintaining: The instance is being maintained.
  • Initializing: The instance is being initialized.
  • InsufficientData: The state cannot be determined due to insufficient data.
  • NotApplicable: The state is not applicable.

All these values are case-sensitive.

Maintaining
EventTypestringNo

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.StartstringNo

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.EndstringNo

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.StartstringNo

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.EndstringNo

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
PageNumberintegerNo

The page number. The value must be a positive integer.

Default value: 1.

1
PageSizeintegerNo

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

Default value: 10.

10
InstanceIdarrayNo

The IDs of the instances. You can specify up to 100 instance IDs in a single request.

stringNo

The ID of instance N.

i-bp67acfmxazb4p****
EventIdarrayNo

The IDs of the system events. You can specify up to 100 event IDs in a single request.

stringNo

The ID of the system event.

e-bp1hygp5b04o56l0****
InstanceEventTypearrayNo

The types of system events. You can specify up to 30 event types in a single request.

stringNo

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 parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

1
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of entries returned.

2
InstanceFullStatusSetobject []

The full status information of the instances.

InstanceIdstring

The ID of the instance.

i-bp67acfmxazb4p****
ScheduledSystemEventSetobject []

Details about the scheduled system events.

EventPublishTimestring

The time when the system event was published. The time is displayed in UTC.

2017-11-30T06:32:31Z
EventIdstring

The ID of the system event.

e-bp1hygp5b04o56l0****
NotBeforestring

The scheduled O&M time of the system event. The time is displayed in UTC.

2017-12-07T00:00:00Z
ImpactLevelstring

The impact level of the system event.

100
Reasonstring

The reason why the system event was scheduled.

A simulated event.
EventCycleStatusobject

The state of the system event.

Namestring

The name of the system event state.

Scheduled
Codeinteger

The code of the system event state.

24
EventTypeobject

The type of the system event.

Namestring

The name of the system event type.

SystemMaintenance.Reboot
Codeinteger

The code of the system event type.

1
ExtendedAttributeobject

The extended attributes of system events generated for instances that have local disks attached.

Devicestring

The device name of the local disk.

/dev/vdb
DiskIdstring

The ID of the local disk.

d-bp67acfmxazb4p****
InactiveDisksobject []

The inactive cloud disks or local disks that have been released and must be cleared.

CreationTimestring

The time when the cloud 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
DeviceSizestring

The size of the cloud disk or local disk. Unit: GiB.

80
DeviceCategorystring

The category of the cloud disk or local 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.
cloud_ssd
DeviceTypestring

The type of the cloud disk or local disk. Valid values:

  • system: system disk.
  • data: data disk.
system
ReleaseTimestring

The time when the cloud 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
Statusobject

The lifecycle state of the instance.

Namestring

The name of the instance lifecycle state.

Running
Codeinteger

The code of the instance lifecycle state.

1
HealthStatusobject

The health state of the instance.

Namestring

The name of the health state.

Warning
Codeinteger

The code of the health state.

64

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403InvalidParameter%sThe specified parameter is invalid.
403InvalidParameter.TimeEndBeforeStart%sThe specified parameter is invalid. Make sure that the end time is later than the start time.
403OperationDenied.NotInWhiteList%sYou are not authorized to perform this operation. Try again when you are authorized.
403InstanceIdLimitExceeded%sMore than 100 instance IDs are specified.
403EventIdLimitExceeded%sMore than 100 simulated event IDs are specified.
404MissingParameter%sA parameter is not specified.

For a list of error codes, visit the Service error codes.