ListJobScriptHistory - SchedulerX - Alibaba Cloud Documentation Center

Queries historical scripts of a job.

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:ReadSchedulerxJobQuery	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobId	long	Yes	The job ID. You can obtain the job ID on the Tasks page in the SchedulerX console.	92583
GroupId	string	Yes	The application ID. You can obtain the application ID on the Applications page in the SchedulerX console.	testSchedulerx.defaultGroup
Namespace	string	Yes	The namespace ID. You can obtain the namespace ID on the Namespaces page in the SchedulerX console.	4F68ABED-AC31-4412-9297-D9A8F0401108
NamespaceSource	string	No	The source of the namespace. This parameter is required only for a special third party.	schedulerx
RegionId	string	Yes	The region ID.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The status code.	200
Message	string	The additional information returned only if an error occurs.	job is not existed, jobId=302
RequestId	string	The request ID.	4F68ABED-AC31-4412-9297-D9A8F0401108
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The information about the jobs.
JobScriptHistoryInfos	array<object>	The information about the job's historical scripts.
JobScriptHistoryInfo	object	The details of the historical script.
VersionesDescription	string	The description of the script version.	init version
Creator	string	The creator.	1272118248844842
CreateTime	string	The creation time.	2025-03-12 14:52:42
ScriptContent	string	The script content.	#!/bin/bash # The following are predefined variables provided by the system. You can use them to obtain information about the job run. echo "Job parameters: #{schedulerx.jobParameters}" echo "Shard index: #{schedulerx.shardingId}" echo "Shard parameters: #{schedulerx.shardingParameters}" echo "Total number of shards: #{schedulerx.shardingNum}" echo "Current retry count: #{schedulerx.attempt}" echo "Trigger type: #{schedulerx.triggerType}" echo "Scheduled timestamp: #{schedulerx.scheduleTime}" echo "Data timestamp: #{schedulerx.dataTime}" # The output of the last line will be returned as the result echo "hello world" # exit 1 indicates failure exit 0

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "job is not existed, jobId=302",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "Data": {
    "JobScriptHistoryInfos": [
      {
        "VersionesDescription": "init version",
        "Creator": 1272118248844842,
        "CreateTime": "2025-03-12 14:52:42\n",
        "ScriptContent": "#!/bin/bash\n\n# The following are predefined variables provided by the system. You can use them to obtain information about the job run.\necho \"Job parameters: #{schedulerx.jobParameters}\"\necho \"Shard index: #{schedulerx.shardingId}\"\necho \"Shard parameters: #{schedulerx.shardingParameters}\"\necho \"Total number of shards: #{schedulerx.shardingNum}\"\necho \"Current retry count: #{schedulerx.attempt}\"\necho \"Trigger type: #{schedulerx.triggerType}\"\necho \"Scheduled timestamp: #{schedulerx.scheduleTime}\"\necho \"Data timestamp: #{schedulerx.dataTime}\"\n\n# The output of the last line will be returned as the result\necho \"hello world\"\n\n# exit 1 indicates failure\nexit 0"
      }
    ]
  }
}

Error codes

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