GetAppGroup - 获取应用分组详情_微服务引擎(MSE)-阿里云帮助中心

获取应用分组。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
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 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==
AppVersion	string	应用版本，1:基础版，2:专业版	2

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

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==",
    "AppVersion": "2"
  },
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

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