ListAppEvents - - Alibaba Cloud Documentation Center

Queries the events that occurred in an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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
sae:ListAppEvents	get	All Resources *	none	none

Request syntax

GET /pop/v1/sam/app/listAppEvents HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The page number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 0 to 10000.	10
AppId	string	No	The application ID.	f7730764-d88f-4b9a-8d8e-cd8efbfe****
ObjectKind	string	No	The type of the object. Valid values: Deployment: an application. Pod: an application instance. Service: a Server Load Balancer (SLB) instance. HorizontalPodAutoscaler: an auto scaling policy. CloneSet: an application.	Pod
ObjectName	string	No	The name of the object. Fuzzy search by prefix is supported.	errew-b86bf540-b4dc-47d8-a42f-b4997c14bd8f-5595cbddd6-x****
EventType	string	No	The type of the event. Valid values: Warning: an alert. Normal: a normal event.	Warning
Reason	string	No	The cause of the event. Fuzzy search by prefix is supported.	Started
Namespace	string	Yes	The namespace ID.	cn-beijing

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
Message	string	The returned message.	success
RequestId	string	The request ID.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	The events.
CurrentPage	integer	The number of the returned page.	1
AppEventEntity	array<object>	The events.
AppEventEntity	object	The events.
ObjectKind	string	The type of the object.	Pod
EventType	string	The type of the event. Valid values:	Normal
LastTimestamp	string	The timestamp of the last occurrence of the event.	2020-02-19T05:01:28Z
Message	string	The information about the event.	Created container
ObjectName	string	The name of the object.	errew-b86bf540-b4dc-47d8-a42f-b4997c14bd8f-5595cbddd6-2****
Reason	string	The cause of the event.	Created
FirstTimestamp	string	The timestamp of the first occurrence of the event.	2020-02-19T05:01:28Z
TotalSize	integer	The total number of events that occurred in an application.	20
PageSize	integer	The number of entries returned per page.	10
ErrorCode	string	The error code returned if the call failed. Take note of the following rules: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the events that occurred in the application were queried. Valid values: true: The events were queried. false: The events failed to be queried.	true

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "AppEventEntity": [
      {
        "ObjectKind": "Pod",
        "EventType": "Normal",
        "LastTimestamp": "2020-02-19T05:01:28Z",
        "Message": "Created container",
        "ObjectName": "errew-b86bf540-b4dc-47d8-a42f-b4997c14bd8f-5595cbddd6-2****",
        "Reason": "Created",
        "FirstTimestamp": "2020-02-19T05:01:28Z"
      }
    ],
    "TotalSize": 20,
    "PageSize": 10
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	get.event.error	Failed to obtain event information.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.

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

Change history

Change time	Summary of changes	Operation

No change history