调用GetAppGroup获取应用分组详情_分布式任务调度 SchedulerX(SchedulerX)-阿里云帮助中心

获取应用分组。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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 of the request	39090022-1F3B-4797-8518-6B61095F1AF0
Code	integer	接口状态码。	200
Message	string	附加信息。	app is not existed, groupId=xxxx, namesapce=xxxx
Success	boolean	调用接口是否成功。取值如下： true：成功 false：失败	true
Data	object	应用分组信息
AppName	string	应用名称	DocTest
Description	string	应用描述	Test
MaxJobs	integer	应用分组可配置最大任务数	1000
GroupId	string	应用ID	testSchedulerx.defaultGroup
MonitorConfigJson	string	报警配置JSON字段。关于此字段的详细说明参见下文关于返回参数的补充说明。	{"sendChannel":"sms,mail,ding"}
CurJobs	integer	应用分组当前配置任务数	1
AppKey	string	应用AppKey	QI4lWMZ+xk1rNB67jFUhaw==

报警通道如下，配置多个逗号分隔。

webhook：ding
短信：sms
邮件：mail
电话：phone

例如：{"sendChannel":"ding,sms,mail,phone"}

示例

正常返回示例

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": "{\"sendChannel\":\"sms,mail,ding\"}",
    "CurJobs": 1,
    "AppKey": "QI4lWMZ+xk1rNB67jFUhaw=="
  }
}

错误码

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