ReportInstancesStatus-阿里云帮助中心

Reports exceptions for one or more Elastic Compute Service (ECS) instances. You can report the same exception that occurs on multiple ECS instances or multiple disks of a single ECS instance.

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:ReportInstancesStatus

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

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
Reason	string	No	The impact of the exception on the ECS instance. Valid values: instance-hang: The ECS instance is unavailable or unreachable. instance-stuck-in-status: The ECS instance remains in a specific state, such as Starting or Stopping, for an extended period. abnormal-network: A network exception occurs on the ECS instance. abnormal-local-disk: An exception occurs on the local disk attached to the ECS instance. abnormal-cloud-disk: An exception occurs on the disk or Shared Block Storage attached to the ECS instance. others: Other exception types. If none of the preceding impact types apply, you can set Reason to others and provide more information in Description.	abnormal-local-disk
Description	string	Yes	The detailed description of the exception.	The local disk is unavailable, access to the mount point is denied, and files cannot be loaded
StartTime	string	No	The start time of the instance failures. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-11-30T06:32:31Z
EndTime	string	No	The end time of the instance failures. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-11-31T06:32:31Z
IssueCategory	string	No	The category of the exception. This parameter is applicable only to ECS Bare Metal instances. Valid values: hardware-cpu-error: CPU failure hardware-motherboard-error: Motherboard failure hardware-mem-error: Memory failure hardware-power-error: Power supply failure hardware-disk-error: Disk failure hardware-networkcard-error: Network interface controller (NIC) failure hardware-raidcard-error: SAS/RAID card failure hardware-fan-error: Fan failure others: Other exceptions	hardware-cpu-error
InstanceId	array	Yes	The IDs of the ECS instances. You can specify up to 100 instance IDs.	i-bp165p6xk2tmdhj0****
	string	No	The ECS instance ID.	i-bp165p6xk2tmdhj0****
DiskId	array	No	The IDs of the disks that have the same exception. You can specify up to 100 disk IDs. If you use ECS Bare Metal instances, specify the serial numbers (SNs) of the disk devices. Note This parameter is required when the Reason parameter is set to abnormal-local-disk or abnormal-cloud-disk, or when the IssueCategory parameter is set to hardware-disk-error.	d-bp1aeljlfad7x6u1****
	string	No	The ID of the disk.	d-bp1aeljlfad7x6u1****
Device	array	No	The device names of the attached disks that have the same exception. You can specify up to 100 device names. If you use ECS Bare Metal instances, specify the slot information of the disk devices. Note For ECS Bare Metal instances, this parameter is required when the Reason parameter is set to abnormal-local-disk or abnormal-cloud-disk, or when the IssueCategory parameter is set to hardware-disk-error.	/dev/xvdb
	string	No	The device name.	/dev/xvdb

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter	%s
403	InstanceIdLimitExceeded	%s	More than 100 instance IDs are specified.
403	DiskIdLimitExceeded	%s	More than 100 disk IDs are specified.
403	InvalidInstanceId.NotFound	%s	The specified instance does not exist. Check whether the InstanceId parameter is valid.
404	MissingParameter	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.