GetEvents API Reference for Flink Runtime Events - Realtime Compute for Apache Flink - Alibaba Cloud - Realtime Compute for Apache Flink

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

stream:GetEvents

get

*All Resource

*

None

Request syntax

GET /api/v2/namespaces/{namespace}/events HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
namespace	string	Yes	The namespace name.	default-namespace

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	Workspace ID.	a14bd5d90a****
pageSize	integer	No	Paging parameter that specifies the number of items per page. Default is 10. Maximum is 100.	10
pageIndex	integer	No	Paging parameter that specifies the page index. Default is 1.	1
deploymentId	string	No	Deployed job ID.	58718c99-3b29-4c5e-93bb-c9fc4ec6****

Response elements

Element	Type	Description	Example
	object	Response data.
requestId	string	Request ID.	CBC799F0-AS7S-1D30-8A4F-882ED4DD****
success	boolean	Indicates whether the business request succeeded.	true
httpCode	integer	Business status code. Always 200. Use the success field to indicate whether the business request succeeded.	200
errorCode	string	When success is false, this field contains a business error code. When success is true, this field is empty.	""
errorMessage	string	When success is false, this field contains a business error message. When success is true, this field is empty.	""
pageIndex	integer	Paging parameter that specifies the page index.	1
pageSize	integer	Paging parameter that specifies the number of items per page.	10
totalSize	integer	Total number of items that match the query conditions.	4
data	array	When success is true, returns a list of jobs that meet the conditions. When success is false, this field is empty.
	Event	This data structure represents runtime events for a deployed job.

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.