批量禁用任務。
接口說明
在調用該接口前,需要在 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());
}
}
}