Use DescribeServiceEvent to query recent service deployment events - Platform For AI - Alibaba Cloud - Platform For AI

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

eas:DescribeServiceEvent

get

*Service

acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region ID of the service.	cn-shanghai
ServiceName	string	Yes	The name of the service. To obtain this name, see ListServices.	foo

Request parameters

Parameter	Type	Required	Description	Example
PageNum	string	No	The page number to return. Default value: 1.	1
PageSize	string	No	The number of events to return per page. Default value: 100.	20
StartTime	string	No	The start time of the query range, in UTC. The default value is 7 days ago.	2006-01-02 15:04:05
EndTime	string	No	The end time of the query range, in UTC. The default value is the current time.	2006-01-02 15:04:05
EventType	string	No	The event type. Valid values: Normal: a normal event. Warning: a warning event. Valid values: Warning : Warning Normal : Normal	Normal
InstanceName	string	No	The name of the service instance. To obtain this name, see ListServiceInstances.	echo-test-784xxxx85d-hhnd8

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	3D491C94-6239-5318-B4B4-799D859***
Events	array<object>	The list of events.
	object	The event details.
Type	string	The event type. Valid values: Normal: a normal event. Warning: a warning event.	Normal
Reason	string	The reason for the event, which indicates a change in the service status.	Updating
Message	string	The event message, which is a JSON-formatted string.	{\"versionId\":1,\"message\":\"Stage scale complete\",\"availableInstance\":1,\"unavailableInstance\":0}
Time	string	The time when the event occurred, in UTC.	2022-04-09 06:30:00
Resource	string	The resource type. Valid values: Service: a service. Pod: a service instance.	Service
TotalCount	integer	The total count of events.	29
TotalPageNum	integer	The total number of pages.	12
PageNum	integer	The current page number.	1

Examples

Success response

JSON format

{
  "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",
      "Resource": "Service"
    }
  ],
  "TotalCount": 29,
  "TotalPageNum": 12,
  "PageNum": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.