創(chuàng)建應(yīng)用分組,返回appKey。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫(xiě)入(Write)、讀?。≧ead)或列出(List)。
- 資源類(lèi)型:是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下:
- 對(duì)于必選的資源類(lèi)型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
edas:CreateSchedulerxAppGroupCreate | create | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
名稱(chēng) | 類(lèi)型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppName | string | 是 | 應(yīng)用名稱(chēng)。 | DocTest |
Namespace | string | 是 | 命名空間 ID,在控制臺(tái)的命名空間頁(yè)面中獲取。 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
NamespaceSource | string | 否 | 暫不支持,無(wú)須填寫(xiě)。 | schedulerx |
GroupId | string | 是 | 應(yīng)用 ID,在控制臺(tái)的應(yīng)用管理頁(yè)面中獲取。 | TestSchedulerx.defaultGroup |
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
Description | string | 否 | 應(yīng)用描述。 | Test |
MaxJobs | integer | 否 | 最大任務(wù)數(shù)。 | 1000 |
NamespaceName | string | 是 | 命名空間名稱(chēng)。 | Test |
AppKey | string | 否 | 應(yīng)用 Appkey。 | adcExHZviLcl**** |
MonitorConfigJson | string | 否 | 報(bào)警配置 JSON 字段。關(guān)于此字段的詳細(xì)說(shuō)明參見(jiàn)下文關(guān)于請(qǐng)求參數(shù)的補(bǔ)充說(shuō)明。 | {"sendChannel":"sms,ding"} |
MonitorContactsJson | string | 否 | 報(bào)警聯(lián)系人 JSON 格式。 | [{"userName":"張三","userPhone":"89756******"},{"userName":"李四","ding":"http://www.example.com"}] |
ScheduleBusyWorkers | boolean | 否 | 是否調(diào)度繁忙機(jī)器。 | false |
EnableLog | boolean | 否 | 是否開(kāi)啟日志。
| true |
AppType | integer | 否 | 應(yīng)用類(lèi)型。
| 1 |
AppVersion | integer | 否 | 應(yīng)用版本,1:基礎(chǔ)版,2:專(zhuān)業(yè)版 | 2 |
關(guān)于請(qǐng)求參數(shù)的補(bǔ)充說(shuō)明
報(bào)警通道如下,配置多個(gè)逗號(hào)分隔。
-
webhook:ding
-
短信:sms
-
郵件:mail
-
電話:phone
例如:{"sendChannel":"ding,sms,mail,phone"}
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Your request is denied as lack of ssl protect.",
"RequestId": "883AFE93-FB03-4FA9-A958-E750C6DE120C",
"Success": true,
"Data": {
"AppGroupId": 6607,
"AppKey": "adcExHZviL******"
},
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-10-21 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2024-06-05 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-05-29 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-03-30 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2022-01-13 | OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
示例 Demo
package com.alibaba.schedulerx.pop;
import com.alibaba.schedulerx.common.util.JsonUtil;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.CreateAppGroupRequest;
import com.aliyuncs.schedulerx2.model.v20190430.CreateAppGroupResponse;
public class TestCreateAppGroup {
public static void main(String[] args) throws Exception {
// OpenAPI 的接入點(diǎn),具體查看上表支持地域列表以及購(gòu)買(mǎi)機(jī)器地域填寫(xiě)。
String regionId = "cn-shanghai";
//鑒權(quán)使用的 AccessKeyId,由阿里云官網(wǎng)控制臺(tái)獲取。
String accessKeyId = "<yourAccessKeyId>";
//鑒權(quán)使用的 AccessKeySecret,由阿里云官網(wǎng)控制臺(tái)獲取。
String accessKeySecret = "<yourAccessKeySecret>";
//產(chǎn)品名稱(chēng)
String productName ="schedulerx2";
//對(duì)照支持地域列表選擇 Domain 填寫(xiě)。
String domain ="schedulerx.cn-shanghai.aliyuncs.com";
//構(gòu)建 OpenAPI 客戶端。
DefaultProfile.addEndpoint(regionId, productName, domain);
DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
CreateAppGroupRequest request = new CreateAppGroupRequest();
request.setNamespace("xxxxxx");
request.setNamespaceName("xxxx");
request.setAppName("xxxx");
request.setDescription("xxx");
request.setGroupId("xxx");
//發(fā)送請(qǐng)求。
CreateAppGroupResponse response = client.getAcsResponse(request);
if (!response.getSuccess()) {
System.out.println(response.getMessage());
System.out.println("createApp: "+response.getRequestId());
} else {
System.out.println(JsonUtil.toJson(response));
}
}
}