批量禁用任务。
接口说明
在调用该接口前，需要在 POM 文件添加以下依赖：
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-schedulerx2</artifactId>
<version>1.0.4</version>
</dependency>
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| edas:ManageSchedulerxJobDisable | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Namespace | string | 是 | 任务所属命名空间 ID，在控制台命名空间页面中获取。 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| NamespaceSource | string | 否 | 特殊第三方才需要填写。 | schedulerx |
| GroupId | string | 否 | 应用 ID，在控制台的应用管理页面中获取。 | testSchedulerx.defaultGroup |
| RegionId | string | 是 | 任务所属地域。 | cn-hangzhou |
| JobIdList | array | 是 | 任务 ID 列表，多个任务 ID 以半角逗号（,）分隔。 | |
| long | 是 | 任务 ID。 | 99341 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "disable failed jobs=[99341]",
"RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB5A7",
"Success": true,
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-12-26 | API 内部配置变更，不影响调用 | 查看变更详情 |
Demo
package com.alibaba.schedulerx.pop;
import com.google.common.collect.Lists;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.BatchDisableJobsRequest;
import com.aliyuncs.schedulerx2.model.v20190430.BatchDisableJobsResponse;
public class TestBatchDisableJobs {
public static void main(String[] args) throws Exception {
// OpenAPI 的接入点，具体查看上表支持地域列表以及购买机器地域填写。
String regionId = "cn-hangzhou";
//鉴权使用的 AccessKey ID，由阿里云官网控制台获取。
String accessKeyId = "xxxxxx";
//鉴权使用的 AccessKey Secret，由阿里云官网控制台获取。
String accessKeySecret = "xxxxxxxx";
//产品名称。
String productName ="schedulerx2";
//对照支持地域列表选择 Domain 填写。
String domain ="schedulerx.cn-hangzhou.aliyuncs.com";
//构建 OpenAPI 客户端。
DefaultProfile.addEndpoint(regionId, productName, domain);
DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
BatchDisableJobsRequest request = new BatchDisableJobsRequest();
request.setNamespace("xxxxxx");
request.setGroupId("xxxxxx");
request.setJobIdLists(Lists.newArrayList(3982L,3984L));
BatchDisableJobsResponse response = client.getAcsResponse(request);
if (!response.getSuccess()) {
System.out.println(response.getMessage());
System.out.println("BatchDisableJob: "+response.getRequestId());
} else {
System.out.println(response.getMessage());
}
}
}