CreateAppGroup
创建应用分组,返回appKey
服务地址:
华东1(杭州)
输入参数
只看必填
AppName应用名称
Namespace命名空间ID
NamespaceSource暂不支持
GroupId应用ID
RegionId地域ID
Description应用描述
MaxJobs最大任务数
NamespaceName命名空间名称
AppKey应用Appkey
MonitorConfigJson报警通知的配置
MonitorContactsJson报警联系人配置
ScheduleBusyWorkers是否调度繁忙机器
请选择布尔值
EnableLog是否开启日志
请选择布尔值
AppType应用类型
AppVersion应用版本
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求参数

字段名称字段详情
AppNamestring

应用名称。

示例值:DocTest参考取值来源:
    GetAppGroup
Namespacestring

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

示例值:adcfc35d-e2fe-4fe9-bbaa-20e90ffc****参考取值来源:
    ListNamespaces
    CreateNamespace
NamespaceSourcestring

暂不支持,无须填写。

示例值:schedulerx
GroupIdstring

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

示例值:TestSchedulerx.defaultGroup参考取值来源:
    ListGroups
RegionIdstring

地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
Descriptionstring

应用描述。

示例值:Test
MaxJobsinteger<int32>

最大任务数。

示例值:1000
NamespaceNamestring

命名空间名称。

示例值:Test参考取值来源:
    ListNamespaces
AppKeystring

应用 Appkey。

示例值:adcExHZviLcl****参考取值来源:
    GetAppGroup
MonitorConfigJsonstring

报警通知的配置,支持以下属性:sendChannel、alarmType 和 webhookIsAtAll。展开详情

示例值:{ "sendChannel": "ding,sms,mail,phone", "alarmType": "Contacts", "webhookIsAtAll": false }
MonitorContactsJsonstring

报警联系人配置。支持配置报警联系人以及报警联系人组展开详情

示例值:[ {"name": "张三"}, {"name": "李四"} ]
ScheduleBusyWorkersboolean

是否调度繁忙机器。

示例值:false
EnableLogboolean

是否开启日志。展开详情

示例值:true
AppTypeinteger<int32>

应用类型。展开详情

示例值:1
AppVersioninteger<int32>

应用版本,1:基础版,2:专业版

示例值:2枚举值:12

请求说明

MonitorConfigJson 补充说明

报警通知的配置,支持以下属性:sendChannelalarmTypewebhookIsAtAll

配置格式

该字段的配置应为 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 格式,支持两种配置:联系人数组和联系人组对象。

属性说明

  • alarmTypeContacts

    • 配置为包含多个联系人对象的数组,每个对象需包含:
      • name: 联系人的名称
  • alarmTypeContactGroup

    • 配置为单个对象,包含:
      • name: 联系人组的名称

注意事项

建议提前创建联系人与联系人组。如果未创建,系统会自动生成相应的联系人和联系人组。用户需在“通知联系人”页面配置联系人手机号、邮箱等信息并激活,以确保报警能够正常发送。

示例

  • 示例 1 (当 alarmTypeContacts):

    [
        {"name": "张三"},
        {"name": "李四"}
    ]
    
  • 示例 2 (当 alarmTypeContactGroup):

    {
        "name": "报警联系人组-1"
    }
    

返回参数

字段名称字段详情
Codeinteger<int32>

返回码。

示例值:200
Messagestring

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

示例值:Your request is denied as lack of ssl protect.
RequestIdstring

请求唯一 ID。

示例值:883AFE93-FB03-4FA9-A958-E750C6DE120C
Successboolean

创建应用是否成功。取值如下:展开详情

示例值:true
Dataobject

任务分组信息。

变更历史
变更时间变更内容概要操作
2024-12-20
变更返回参数
2024-10-21
变更返回参数
2024-06-05
删除请求参数Version
新增请求参数AppVersion
2024-05-29
新增请求参数Version
2023-03-30
删除返回参数
2022-01-13
变更请求参数NamespaceName
新增请求参数AppKey
新增请求参数MonitorConfigJson
新增请求参数MonitorContactsJson
变更返回参数