Monitor Stack & Resource Events with ListStackEvents API - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Queries events of a stack and the resources in the stack.

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

ros:ListStackEvents

get

*stack

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

None

Request syntax

POST /V2/ListStackEvents HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The stack ID.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
PageSize	integer	No	The number of entries per page in a paged query. Settings for paging. Maximum value: 50. Default value: 10.	10
RegionId	string	Yes	The region ID of the stack. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The page number of the event list. Minimum value: 1. Default value: 1.	1
Status	array	No	The resource status.	CREATE_IN_PROGRESS
	string	No	The resource status. Valid values: CREATE_COMPLETE CREATE_FAILED CREATE_IN_PROGRESS UPDATE_IN_PROGRESS UPDATE_FAILED UPDATE_COMPLETE UPDATE_SKIPPED DELETE_IN_PROGRESS DELETE_FAILED CHECK_IN_PROGRESS CHECK_FAILED CHECK_COMPLETE IMPORT_IN_PROGRESS IMPORT_FAILED IMPORT_COMPLETE.	CREATE_IN_PROGRESS
ResourceType	array	No	The resource type list.	ALIYUN::ECS::Instance
	string	No	The resource type list. Maximum value of N: 200. For more information about resource types, see Resource type index.	ALIYUN::ECS::Instance
LogicalResourceId	array	No	The logical resource ID.	WebServer
	string	No	The logical resource ID, which is the resource name defined in the template.	WebServer

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of events.	20
PageSize	integer	The number of entries per page in a paged query. Settings for paging. Maximum value: 50. Default value: 10.	10
RequestId	string	The request ID.	B288A0BE-D927-4888-B0F7-B35EF84B6E6
PageNumber	integer	The page number of the event list. Minimum value: 1. Default value: 1.	1
Events	array<object>	The list of event objects.
	object
Status	string	The status of the resource.	CREATE_COMPLETE
EventId	string	The event ID.	0086612d-77cf-4056-b0b5-ff8e94ad****
LogicalResourceId	string	The logical resource ID, which is the resource name defined in the template.	WebServer
StackId	string	The stack ID.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
PhysicalResourceId	string	The physical ID of the resource.	i-m5e3tfdbinchnexh****
ResourceType	string	The resource type.	ALIYUN::ECS::Instance
StatusReason	string	The reason for the status.	state changed
CreateTime	string	The time when the event was created. The time is displayed in UTC+0 and follows the ISO 8601 standard without the Z suffix. Format: YYYY-MM-DDThh:mm:ss.	2019-08-01T04:07:39
StackName	string	The stack name.	StackName

Examples

Success response

JSON format

{
  "TotalCount": 20,
  "PageSize": 10,
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "PageNumber": 1,
  "Events": [
    {
      "Status": "CREATE_COMPLETE",
      "EventId": "0086612d-77cf-4056-b0b5-ff8e94ad****",
      "LogicalResourceId": "WebServer",
      "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
      "PhysicalResourceId": "i-m5e3tfdbinchnexh****",
      "ResourceType": "ALIYUN::ECS::Instance",
      "StatusReason": "state changed",
      "CreateTime": "2019-08-01T04:07:39",
      "StackName": "StackName"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.