文档

DisableJob - 停用指定任务

更新时间:
一键部署

停用指定任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JobIdlong

任务ID,在控制台的任务管理页面中获取。

92583
Namespacestring

命名空间ID,在控制台的命名空间页面中获取。

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

特殊第三方才需要填写。

schedulerx
GroupIdstring

应用ID,在控制台的应用管理页面中获取。

testSchedulerx.defaultGroup
RegionIdstring

地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
Codeinteger

返回码

200
Messagestring

错误消息,仅出错时返回错误信息。

jobid: 92583 not match groupId: testSchedulerx.defaultGroup
RequestIdstring

请求唯一ID

C8E5FB4A-6D8D-424D-9AAA-4FE06BB74FF9
Successboolean

禁用任务是否成功。取值如下:

  • true:禁用任务成功。
  • false:禁用任务失败。
true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "jobid: 92583 not match groupId: testSchedulerx.defaultGroup",
  "RequestId": "C8E5FB4A-6D8D-424D-9AAA-4FE06BB74FF9",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-12-26API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用

Demo

package com.alibaba.schedulerx.pop;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.DisableJobRequest;
import com.aliyuncs.schedulerx2.model.v20190430.DisableJobResponse;

public class DisableJob {

    public static void main(String[] args) throws Exception {
     // OpenAPI的接入点,具体查看上表支持地域列表以及购买机器地域填写。
        String regionId = "cn-shanghai";
        //鉴权使用的AccessKeyId,由阿里云官网控制台获取。
        String accessKeyId = "<yourAccessKeyId>";
        //鉴权使用的AccessKeySecret,由阿里云官网控制台获取。
        String accessKeySecret = "<yourAccessKeySecret>";
        //产品名称。
        String productName ="schedulerx2";
        //对照支持地域列表选择Domain填写。
        String domain ="schedulerx.cn-shanghai.aliyuncs.com";
        //构建OpenAPI客户端。
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        DisableJobRequest request = new DisableJobRequest();
        request.setNamespace("xxxxxx");
        request.setGroupId("xxxxxx");
        request.setJobId(123L);
        DisableJobResponse response = client.getAcsResponse(request);
        if (!response.getSuccess()) {
            System.out.println(response.getMessage());
            System.out.println("DisableJob: "+response.getRequestId());
        } else {
            System.out.println(response.getMessage());
        }
    }
    
}
  • 本页导读 (1)