GetOverview - SchedulerX - Alibaba Cloud Documentation Center

Retrieves job scheduling data for Professional Edition applications.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadSchedulerxOverviewQuery	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
Namespace	string	No	The unique identifier (UID) of the namespace.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	No	The source of the namespace. This parameter is required only for a special third party.	schedulerx
GroupId	string	No	The application group ID.	testSchedulerx.defaultGroup
Operate	string	Yes	The query type. Valid values: query: queries data in a time range. query_range: queries time series data in a time range.	query
MetricType	integer	Yes	The metric type. Valid values: 0: the basic job data. 1: the job running data.	0
StartTime	long	Yes	The beginning of the time range to query. The value must be a UNIX timestamp (in seconds).	1684166400
EndTime	long	No	The end of the time range to query. The value must be a UNIX timestamp (in seconds). If left empty, the current time is used.	1684166400

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	39090022-1F3B-4797-8518-6B61095F1AF0
Code	integer	The status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	Additional information. Returned only if an error occurs.	No access permission for the namespace [***]
Data	string	The data returned in JSON format. Valid data types: Basic job data. Job running data. Time series data for job execution: includes triggering statistics, records of successful and failed executions, and their associated timestamps within a specific time range.	{"schedulerx_job_counter_disable": "4","schedulerx_job_trigger_counter_running": "0","schedulerx_job_counter_enable": "70","schedulerx_job_counter_all": "74","schedulerx_worker_counter": "2"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "No access permission for the namespace [***]",
  "Data": {
    "schedulerx_job_counter_disable": 4,
    "schedulerx_job_trigger_counter_running": 0,
    "schedulerx_job_counter_enable": 70,
    "schedulerx_job_counter_all": 74,
    "schedulerx_worker_counter": 2
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-18	The response structure of the API has changed	View Change Details