ReportInstancesStatus-阿里云帮助中心

Reports an exception on Elastic Compute Service (ECS) instances. You can report the same exception on multiple ECS instances or on multiple disks of an 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
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 instance. Valid values: instance-hang: The instance is unavailable or cannot be connected. instance-stuck-in-status: The instance is stuck in a state such as Starting or Stopping. abnormal-network: The instance has a network exception. abnormal-local-disk: A local disk attached to the instance has an exception. abnormal-cloud-disk: A disk or a Shared Block Storage device attached to the instance has an exception. others: other exception types. If the impact is not of the preceding types, you can set `Reason` to others and specify the `Description` parameter.	abnormal-local-disk
Description	string	Yes	The description of the exception.	本地盘不可用，挂载点拒绝访问，无法加载文件。
StartTime	string	No	The start time of the instance exception. 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 exception. 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 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 failures	hardware-cpu-error
InstanceId	array	Yes	The IDs of instances. You can specify up to 100 instance IDs in a single request.	i-bp165p6xk2tmdhj0****
	string	No	The ID of instance N.	i-bp165p6xk2tmdhj0****
DiskId	array	No	The IDs of disks on an instance that have the exception. You can specify up to 100 disk IDs in a single request. If you are using an ECS bare metal instance, enter the serial numbers of disks on the instance. Note This parameter is required when the value of the `Reason` parameter is `abnormal-local-disk` or `abnormal-cloud-disk` or when the value of the `IssueCategory` parameter is `hardware-disk-error`.	d-bp1aeljlfad7x6u1****
	string	No	The ID of disk N.	d-bp1aeljlfad7x6u1****
Device	array	No	The device names of disks on an instance that have the exception. You can specify to 100 device names in a single request. If you are using an ECS bare metal instance, enter the slot numbers of disks on the instance. Note For ECS bare metal instances, this parameter is required when the value of the `Reason` parameter is `abnormal-local-disk` or `abnormal-cloud-disk` or when the value of the `IssueCategory` parameter is `hardware-disk-error`.	/dev/xvdb
	string	No	The device name of disk N.	/dev/xvdb

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	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.