GetLogEvent-阿里云帮助中心

Query Events.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The unique identifier for the cluster.	xxljob-684d02ee5a6
AppName	string	No	The name of the application.	xxl-job-executor-perf-test-241
EventType	string	No	The type of event to retrieve.	JOB
JobName	string	No	The name of the job.	test
JobExecutionId	integer	No	The unique identifier for the job execution.	101
WorkflowName	string	No	The name of the workflow.	流程001
WorkflowExecutionId	integer	No	The unique identifier for the workflow execution.	1450568762586578000
StartTime	integer	No	The start of the query's time range, specified as a Unix timestamp in milliseconds.	1721268302000
EndTime	integer	No	The end of the query's time range, specified as a Unix timestamp in milliseconds.	1721636220
Event	string	No	The severity level for filtering events.	INFO
Keyword	string	No	A keyword to search for in log events.	test_partition_tbl
PageSize	integer	No	The maximum number of results to return per page.	10
PageNum	integer	No	The page number to retrieve.	1
Reverse	boolean	No	Specifies the sort order of events. true: Sorts events in descending order. false: Sorts events in ascending order.	false

Response elements

Element	Type	Description	Example
	object	The response object.
Code	integer	The HTTP status code. A value of `200` indicates a successful request.	200
RequestId	string	The unique, server-generated ID for the request. This ID is used for troubleshooting purposes.	BAC1ADB5-EEB5-5834-93D8-522E067AF8D9
Message	string	The error message that is returned if the request fails.	Parameter check error
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object
Records	array<object>
	object
EventType	string	The type of the event.	JOB
AppName	string	The name of the application.	portal-dev
JobName	string	The name of the job.	test
JobExecutionId	string	The job execution ID.	101
WorkflowName	string	The name of the workflow.	工作流0001
WorkflowExecutionId	string	The workflow execution ID.	1450568762586578000
Event	string	The severity level of the event.	info
WorkerAddr	string	The address of the worker that runs the job.	030225016025_9357_60125@127.0.0.1:51363
Content	string	The log content.	hello word
Time	string	The time when the log was recorded. The time is in the `yyyy-MM-dd HH:mm:ss` format.	2024-10-31 16:43:51
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10
Total	integer	The total number of entries.	33

Examples

Success response

JSON format

{
  "Code": 200,
  "RequestId": "BAC1ADB5-EEB5-5834-93D8-522E067AF8D9",
  "Message": "Parameter check error",
  "Success": true,
  "Data": {
    "Records": [
      {
        "EventType": "JOB",
        "AppName": "portal-dev",
        "JobName": "test",
        "JobExecutionId": "101",
        "WorkflowName": "工作流0001",
        "WorkflowExecutionId": "1450568762586578000",
        "Event": "info",
        "WorkerAddr": "030225016025_9357_60125@127.0.0.1:51363",
        "Content": "hello word",
        "Time": "2024-10-31 16:43:51"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "Total": 33
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Parameter error: %s.	Parameter error: %s
401	IllegalRequest	IllegalRequest: %s.	Illegal request:%s
500	InternalError	InternalError: %s.	System Internal Error: %s
403	NoPermission	No permission to perform this operation: %s.	No permission to perform this operation: %s
404	NotFound	Not found: %s.	The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.