UpdateJobScript-阿里云帮助中心

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

edas:ManageSchedulerxJobModify

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	integer	Yes	The job ID. You can obtain the ID on the Tasks page in the SchedulerX console.	301
Namespace	string	Yes	The namespace ID. You can obtain the namespace ID on the Namespaces page in the SchedulerX console.	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	Yes	The application ID. You can obtain the application ID on the Applications page in the SchedulerX console.	testSchedulerx.defaultGroup
RegionId	string	Yes	The region ID.	cn-hangzhou
VersionDescription	string	No	The description of the script version.	Print job runtime information
ScriptContent	string	No	The script content.	#!/bin/bash # The following are built-in variables provided by the system to retrieve job runtime information echo "Job parameters: #{schedulerx.jobParameters}" echo "Sharding ID: #{schedulerx.shardingId}" echo "Sharding parameters: #{schedulerx.shardingParameters}" echo "Total shards: #{schedulerx.shardingNum}" echo "Retry attempts: #{schedulerx.attempt}" echo "Trigger type: #{schedulerx.triggerType}" echo "Schedule timestamp: #{schedulerx.scheduleTime}" echo "Data timestamp: #{schedulerx.dataTime}" # The last line of output will be returned as the result echo "hello world" # exit 1 indicates failure exit 0

Response elements

Element	Type	Description	Example
	object
Code	integer	The returned 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.	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "job is not existed, jobId=302",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108\n",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.