DescribeServiceEvent - Platform For AI - Alibaba Cloud Documentation Center

Queries information about recent service deployment events.

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
eas:DescribeServiceEvent	get	*Service `acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}`	none	none

Request syntax

GET /api/v2/services/{ClusterId}/{ServiceName}/events HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNum	string	No	The page number. Default value: 1.	1
PageSize	string	No	The number of entries per page. Default value: 100.	20
ClusterId	string	Yes	The region ID of the service.	cn-shanghai
ServiceName	string	Yes	The service name. For more information about how to query the service name, see ListServices .	foo
StartTime	string	No	The beginning of the time range to query. The time must be in UTC. The default value is seven days ago.	2006-01-02 15:04:05
EndTime	string	No	The end of the time range to query. By default, the current point in time is the end of the time range to query.	2006-01-02 15:04:05
EventType	string	No	The event type. Valid values: Normal Warning	Normal
InstanceName	string	No	The instance name. For more information about how to obtain the instance name, see ListServiceInstances .	echo-test-784xxxx85d-hhnd8

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	3D491C94-6239-5318-B4B4-799D859***
Events	array<object>	The events.
events	object
Type	string	The event type. Valid values: Normal Warning	Normal
Reason	string	The cause of the event. The information about the change in the service status is returned.	Updating
Message	string	The returned message. The message is formatted and returned in the JSON format.	{\"versionId\":1,\"message\":\"Stage scale complete\",\"availableInstance\":1,\"unavailableInstance\":0}
Time	string	The time when the event occurred. The time must be in UTC.	2022-04-09 06:30:00
TotalCount	long	The total number of entries returned.	29
TotalPageNum	long	The total number of pages returned.	12
PageNum	long	The page number.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "3D491C94-6239-5318-B4B4-799D859***",
  "Events": [
    {
      "Type": "Normal",
      "Reason": "Updating",
      "Message": "{\\\"versionId\\\":1,\\\"message\\\":\\\"Stage scale complete\\\",\\\"availableInstance\\\":1,\\\"unavailableInstance\\\":0}",
      "Time": "2022-04-09 06:30:00"
    }
  ],
  "TotalCount": 29,
  "TotalPageNum": 12,
  "PageNum": 1
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-03-31	The request parameters of the API has changed	View Change Details