ListScheduleEvent-阿里云帮助中心

Lists scheduled 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 Cluster ID.	xxljob-b6ec1xxxx
AppName	string	No	The application name.	test-app
JobName	string	No	The job name.	test-job
JobExecutionId	string	No	The job execution ID.	1310630367761285120
WorkflowName	string	No	The workflow name.	流程001
WorkflowExecutionId	integer	No	The workflow execution ID.	1450568762586578000
StartTime	integer	No	The start of the time range to query events. This is a Unix timestamp in milliseconds.	1581317873000
EndTime	integer	No	The end of the time range to query events. This is a Unix timestamp in milliseconds.	1728872796295
Event	string	No	The event status to filter by. Valid values: Scheduled Running Succeeded Failed Failing_Auto_Retry Skip_Schedule Execute_Log	Failed
EventType	string	No	The event type.	JOB \| WORKFLOW
Keyword	string	No	The search keyword.	hello word
PageSize	integer	No	The number of events to return per page.	10
PageNum	integer	No	The page number.	1
Reverse	boolean	No	Specifies whether to sort the results in descending order. Set to `true` for descending order or `false` for ascending order. Default is `false`.	true

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The unique identifier for the request, which is used to troubleshoot issues.	B880122A-B0E4-52E8-8F54-87DB7779EB74
Code	integer	The response code.	200
Message	string	The returned error message.	Parameter check error
Success	boolean	Indicates whether the call was successful. true: The call succeeded. false: The call failed.	true
Data	object	The returned data.
Records	array<object>	The array of event records.
	object	The event record.
EventType	string	The event type.	JOB
AppName	string	The application name.	test-app
JobName	string	The job name.	test-job
JobExecutionId	string	The job execution ID.	1310630367761285120
WorkflowName	string	The workflow name.	工作流0001
WorkflowExecutionId	string	The workflow execution ID.	1450568762586578000
Event	string	The event status.	Failed
WorkerAddr	string	The worker address.	http://192.168.1.5:9999/
Content	string	The event content.	hello word
Time	string	The timestamp of the event. The time is in the `yyyy-MM-dd HH:mm:ss` format.	2024-10-31 16:43:51
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Total	integer	The total number of entries.	100

Examples

Success response

JSON format

{
  "RequestId": "B880122A-B0E4-52E8-8F54-87DB7779EB74",
  "Code": 200,
  "Message": "Parameter check error",
  "Success": true,
  "Data": {
    "Records": [
      {
        "EventType": "JOB",
        "AppName": "test-app",
        "JobName": "test-job",
        "JobExecutionId": "1310630367761285120",
        "WorkflowName": "工作流0001",
        "WorkflowExecutionId": "1450568762586578000",
        "Event": "Failed",
        "WorkerAddr": "http://192.168.1.5:9999/",
        "Content": "hello word\n",
        "Time": "2024-10-31 16:43:51\n"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "Total": 100
  }
}

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.