List Gateway Alert Events via ListAlertEvents API - Cloud Storage Gateway - Alibaba Cloud - Cloud Storage Gateway

Lists alert events for a gateway.

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

hcs-sgw:ListAlertEvents

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	No	The ID of the gateway.	gw-000eg44nmxbsfwbvq***
ShareIndexId	string	No	The share name.	nfs_share
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
FirstTriggerTimestampStartTime	integer	No	The start timestamp.	1761559501337
FirstTriggerTimestampEndTime	integer	No	The end timestamp.	1761570323090
GatewayRegionId	string	No	The ID of the region where the gateway is located.	cn-shanghai
Status	string	No	The status of the alert events. If you set this parameter to alerting, only the events that are being triggered are listed. If you do not specify this parameter, all alert events are listed.	alerting

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	395B1136-982E-4F95-BDCE-7323FFEF499E
Success	boolean	Indicates whether the call was successful. true: The call was successful. false: The call failed.	true
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Message	string	The returned message.	successful
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of alert events.	20
AlertEvents	array<object>	The information about the alert events.
	object	The information about the alert event.
Type	string	The alert type. Valid values: throttling: Throttling. uploadQueueFull: The upload queue is full. lowMetaSpace: The metadata space is insufficient.	uploadQueueFull
FirstTriggerTimestamp	integer	The time when the alert was first triggered. This value is a UNIX timestamp.	1761559501337
GatewayId	string	The ID of the gateway.	gw-000dx594q3j5o663s8nx
LastTriggerTimestamp	integer	The time when the alert was last triggered. This value is a UNIX timestamp.	1761570323090
StorageBundleId	string	The ID of the gateway cluster.	sb-000iymnht76bdwsho0lm
ShareIndexId	string	The index ID of the share.	NFSnfs_share
Level	string	The severity level of the alert. The value is warn.	warn
AccountId	integer	This parameter is deprecated.	”“
Status	string	The status of the alert event. Valid values: alerting: The alert is being triggered. restored: The service has returned to normal. gatewayDeleted: The gateway is deleted. shareDeleted: The share is deleted.	alerting
RegionId	string	The ID of the region where the gateway is located.	cn-shanghai
Display	boolean	This parameter is deprecated.	”“
ShareStatus	string	This parameter is deprecated.	”“
GatewayStatus	string	This parameter is deprecated.	”“

Examples

Success response

JSON format

{
  "RequestId": "395B1136-982E-4F95-BDCE-7323FFEF499E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 20,
  "AlertEvents": [
    {
      "Type": "uploadQueueFull",
      "FirstTriggerTimestamp": 1761559501337,
      "GatewayId": "gw-000dx594q3j5o663s8nx",
      "LastTriggerTimestamp": 1761570323090,
      "StorageBundleId": "sb-000iymnht76bdwsho0lm",
      "ShareIndexId": "NFSnfs_share",
      "Level": "warn",
      "AccountId": 0,
      "Status": "alerting",
      "RegionId": "cn-shanghai",
      "Display": true,
      "ShareStatus": "”“",
      "GatewayStatus": "”“"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.