获取应用分组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
edas:ReadSchedulerxAppGroupQuery |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| GroupId |
string |
是 |
应用 ID,在控制台的应用管理页面中获取。 |
testSchedulerx.defaultGroup |
| Namespace |
string |
是 |
命名空间 ID,在控制台的命名空间页面中获取 |
adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求唯一 ID。 |
39090022-1F3B-4797-8518-6B61095F1AF0 |
| Code |
integer |
接口状态码。 |
200 |
| Message |
string |
附加信息。 |
app is not existed, groupId=xxxx, namesapce=xxxx |
| Success |
boolean |
调用接口是否成功。取值如下:
|
true |
| Data |
object |
应用分组信息。 |
|
| AppName |
string |
应用名称。 |
DocTest |
| Description |
string |
应用描述。 |
Test |
| MaxJobs |
integer |
应用分组可配置最大任务数。 |
1000 |
| GroupId |
string |
应用 ID。 |
testSchedulerx.defaultGroup |
| MonitorConfigJson |
string |
报警通知的配置。 说明
此字段的详细说明参见下文关于请求参数的补充说明 |
{ "sendChannel": "ding,sms,mail,phone", "alarmType": "Contacts", "webhookIsAtAll": false } |
| CurJobs |
integer |
应用分组当前配置任务数。 |
1 |
| AppKey |
string |
应用 AppKey。 |
QI4lWMZ+xk1rNB67jFUhaw== |
| AppVersion |
string |
应用版本,1:基础版,2:专业版。 |
2 |
| Namespace |
string |
命名空间 ID。 |
adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| MonitorContactsJson |
string |
报警联系人配置。 说明
此字段的详细说明参见下文关于请求参数的补充说明。 |
[ {"name": "Alice Johnson"}, {"name": "Lee Smith"} ] |
| NotificationPolicyName |
string |
通知策略名称 |
test-workday-notification |
| EnableLog |
boolean |
MonitorConfigJson 补充说明
报警通知的配置,支持以下属性:sendChannel、alarmType 和 webhookIsAtAll。
配置格式
该字段的配置应为 JSON 格式,支持以下属性:
属性说明
-
发送渠道(
sendChannel):- 支持多个渠道,使用逗号分隔,选项包括:
webhook:
ding。短信:
sms。邮件:
mail。电话:
phone。
- 支持多个渠道,使用逗号分隔,选项包括:
-
报警类型(
alarmType):Contacts: 表示报警联系人。
ContactGroup: 表示报警联系人组。
-
是否 @ 所有成员(
webhookIsAtAll):值为
"true"或"false",指示在发送通知时是否 @ 所有群成员。
示例:
{
"sendChannel": "ding,sms,mail,phone",
"alarmType": "Contacts",
"webhookIsAtAll": true
}
MonitorContactsJson 补充说明
报警联系人配置,根据 alarmType 的不同提供两种格式。
配置格式
该字段应为 JSON 格式,支持两种配置:联系人数组和联系人组对象。
属性说明
-
当
alarmType为Contacts:- 配置为包含多个联系人对象的数组,每个对象需包含:
name: 联系人的名称。
- 配置为包含多个联系人对象的数组,每个对象需包含:
-
当
alarmType为ContactGroup:- 配置为单个对象,包含:
name: 联系人组的名称。
- 配置为单个对象,包含:
示例:
-
示例 1 (当
alarmType为Contacts):[ {"name": "张三"}, {"name": "李四"} ] -
示例 2 (当
alarmType为ContactGroup):{ "name": "报警联系人组-1" }
示例
正常返回示例
JSON格式
{
"RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
"Code": 200,
"Message": "app is not existed, groupId=xxxx, namesapce=xxxx",
"Success": true,
"Data": {
"AppName": "DocTest",
"Description": "Test",
"MaxJobs": 1000,
"GroupId": "testSchedulerx.defaultGroup",
"MonitorConfigJson": "{\n \"sendChannel\": \"ding,sms,mail,phone\",\n \"alarmType\": \"Contacts\",\n \"webhookIsAtAll\": false\n}",
"CurJobs": 1,
"AppKey": "QI4lWMZ+xk1rNB67jFUhaw==",
"AppVersion": "2",
"Namespace": "adcfc35d-e2fe-4fe9-bbaa-20e90ffc****",
"MonitorContactsJson": "[\n {\"name\": \"Alice Johnson\"},\n {\"name\": \"Lee Smith\"}\n]",
"NotificationPolicyName": "test-workday-notification",
"EnableLog": true
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。