All Products
Search
Document Center

SchedulerX:EnableJob

Last Updated:Dec 10, 2024

Enables 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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ManageSchedulerxJobEnableupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdlongYes

The job ID. You can obtain the job ID on the Task Management page in the SchedulerX console.

92583
NamespacestringYes

The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestringNo

The source of the namespace. This parameter is required only for a special third party.

schedulerx
GroupIdstringNo

The application ID. You can obtain the application ID on the Application Management page in the SchedulerX console.

testSchedulerx.defaultGroup
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code.

200
Messagestring

The error message that is returned only if the corresponding error occurs.

jobid: 92583 not match groupId: testSchedulerx.defaultGroup
RequestIdstring

The request ID.

71BCC0E3-64B2-4B63-A870-AFB64EBCB5A7
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "jobid: 92583 not match groupId: testSchedulerx.defaultGroup",
  "RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB5A7",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-10-21The response structure of the API has changedView Change Details
2022-12-26The internal configuration of the API is changed, but the call is not affectedView Change Details

Sample code

package com.alibaba.schedulerx.pop;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.EnableJobRequest;
import com.aliyuncs.schedulerx2.model.v20190430.EnableJobResponse;

public class EnableJob {

    public static void main(String[] args) throws Exception {
     // The region ID. Enter a value by referring to the Endpoints topic or based on the region in which you purchased the service. 
        String regionId = "cn-shanghai";
        // The AccessKey ID that is used for authentication. You can obtain the AccessKey ID in the RAM console. 
        String accessKeyId = "<yourAccessKeyId>";
        // The AccessKey secret that is used for authentication. You can obtain the AccessKey secret in the RAM console. 
        String accessKeySecret = "<yourAccessKeySecret>";
        // The name of the service. 
        String productName ="schedulerx2";
        // The domain. Enter a domain by referring to the Endpoints topic. 
        String domain ="schedulerx.cn-shanghai.aliyuncs.com";
        // Build an API client. 
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        EnableJobRequest request = new EnableJobRequest();
        request.setNamespace("xxxxxx");
        request.setGroupId("xxxxxx");
        request.setJobId(123L);
        EnableJobResponse response = client.getAcsResponse(request);
        if (!response.getSuccess()) {
            System.out.println(response.getMessage());
            System.out.println("EnableJob: "+response.getRequestId());
        } else {
            System.out.println(response.getMessage());
        }
    }
    
}