GetAppGroup - 获取应用分组详情

获取应用分组。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadSchedulerxAppGroupQueryget
*全部资源
*

请求参数

名称类型必填描述示例值
GroupIdstring

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

testSchedulerx.defaultGroup
Namespacestring

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

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
RegionIdstring

地域 ID

cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

39090022-1F3B-4797-8518-6B61095F1AF0
Codeinteger

接口状态码。

200
Messagestring

附加信息。

app is not existed, groupId=xxxx, namesapce=xxxx
Successboolean

调用接口是否成功。取值如下:

  • true:成功

  • false:失败

true
Dataobject

应用分组信息

AppNamestring

应用名称

DocTest
Descriptionstring

应用描述

Test
MaxJobsinteger

应用分组可配置最大任务数

1000
GroupIdstring

应用 ID

testSchedulerx.defaultGroup
MonitorConfigJsonstring

报警通知的配置

说明 此字段的详细说明参见下文关于请求参数的补充说明
{ "sendChannel": "ding,sms,mail,phone", "alarmType": "Contacts", "webhookIsAtAll": false }
CurJobsinteger

应用分组当前配置任务数

1
AppKeystring

应用 AppKey

QI4lWMZ+xk1rNB67jFUhaw==
AppVersionstring

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

2
Namespacestring

命名空间 ID

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
MonitorContactsJsonstring

报警联系人配置

说明 此字段的详细说明参见下文关于请求参数的补充说明
[ {"name": "张三"}, {"name": "李四"} ]

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"
    }
    

示例

正常返回示例

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\": \"张三\"},\n    {\"name\": \"李四\"}\n]"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-10-17OpenAPI 返回结构发生变更查看变更详情
2024-06-05OpenAPI 返回结构发生变更查看变更详情
2023-03-30API 内部配置变更,不影响调用查看变更详情