更新应用分组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
edas:ManageSchedulerxAppGroupModify | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Description | string | 否 | 应用描述。 | Test |
GroupId | string | 是 | 应用 ID,在控制台的应用管理页面中获取。 | testSchedulerx.defaultGroup |
MaxConcurrency | integer | 否 | 最大同时运行实例数量,默认值为 1,即上次触发没有运行结束,即使到了运行时刻也不会进行下次触发。 | 1 |
Namespace | string | 是 | 命名空间 ID,在控制台的命名空间页面中获取。 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
RegionId | string | 是 | 地域 ID | cn-hangzhou |
AppVersion | integer | 否 | 应用版本,1:基础版,2:专业版 | 2 |
MonitorConfigJson | string | 否 | 报警通知的配置,支持以下属性:sendChannel、alarmType 和 webhookIsAtAll。 说明
此字段的详细说明参见下文关于请求参数的补充说明。
| { "sendChannel": "ding,sms,mail,phone", "alarmType": "Contacts", "webhookIsAtAll": false } |
MonitorContactsJson | string | 否 | 报警联系人配置。支持配置报警联系人以及报警联系人组 说明
此字段的详细说明参见下文关于请求参数的补充说明。
| [ {"name": "张三"}, {"name": "李四"} ] |
返回参数
MonitorConfigJson 补充说明
报警通知的配置,支持以下属性:sendChannel
、alarmType
和 webhookIsAtAll
。
配置格式
该字段的配置应为 JSON 格式,支持以下属性:
属性说明
-
发送渠道(
sendChannel
):- 支持多个渠道,使用逗号分隔,选项包括:
- webhook:
ding
- 短信:
sms
- 邮件:
mail
- 电话:
phone
- webhook:
- 支持多个渠道,使用逗号分隔,选项包括:
-
报警类型(
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": "4F68ABED-AC31-4412-9297-D9A8F0401108",
"Code": 200,
"Message": "app is not existed, groupId=xxxx, namesapce=xxxx",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-10-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-06-05 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-29 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-03-25 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-03-30 | API 内部配置变更,不影响调用 | 查看变更详情 |