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
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:DescribeInstancesFullStatus | get | *All Resources * |
| 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:
| Running |
| HealthStatus | string | No | The health status of the instance. Valid values:
All the values are case-sensitive. | Maintaining |
| EventType | string | No | The type of the system event. This parameter is valid only when InstanceEventType.N is not specified. Valid values:
| 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. | |
| 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. | |
| 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. | |
| string | No | The type of the system event. Valid values:
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
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 code | Error code | Error message | Description |
|---|---|---|---|
| 403 | InvalidParameter | %s | The specified parameter is invalid. |
| 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 | More than 100 simulated event IDs are specified. |
| 404 | MissingParameter | %s | A parameter is not specified. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|