The configuration of the alert. The value is a JSON string. For more information, see \\\\*\\\\*the additional information about response parameters below this table\\\\*\\\\*.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadSchedulerxAppGroupQuery	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the application. You can obtain the application ID on the Application Management page in the SchedulerX console.	testSchedulerx.defaultGroup
Namespace	string	Yes	The ID of the namespace. You can obtain the ID of the namespace on the Namespace page in the SchedulerX console.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
RegionId	string	No	The ID of the region.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	39090022-1F3B-4797-8518-6B61095F1AF0
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	app is not existed, groupId=xxxx, namesapce=xxxx
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The information about the application group.
AppName	string	The name of the application.	DocTest
Description	string	The description of the application.	Test
MaxJobs	integer	The maximum number of jobs that can be configured for the application group.	1000
GroupId	string	The ID of the application.	testSchedulerx.defaultGroup
MonitorConfigJson	string	The alert notification configurations. Note For more information about this parameter, see the following additional information about request parameters.	{"sendChannel":"sms,mail,ding"}
CurJobs	integer	The number of jobs that are configured for the application group.	1
AppKey	string	The AppKey of the application.	QI4lWMZ+xk1rNB67jFUhaw==
AppVersion	string	The application version. 1: Basic version, 2: Professional version.	2
Namespace	string	The ID of the namespace.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
MonitorContactsJson	string	The alert contact configurations. Note For more information about this parameter, see the following additional information about request parameters.	\[ {"name": "Peter"}, {"name": "Paul"} ]

Additional information about the MonitorConfigJson parameter

The alert notification configurations support the following attributes: sendChannel, alarmType, and webhookIsAtAll.

Format

The value of this parameter is in the JSON format. The attributes described below are supported.

Attribute description

****sendChannel:
- The channel used to send alert notifications. You can specify multiple channels separated by commas. Valid values:
  - webhook: ding
  - sms: text message
  - mail: email
  - phone: phone call
****alarmType:
- Contacts: the alert contacts.
- ContactGroup: the alert contact group.
****webhookIsAtAll:
- Valid values: "true" and "false". This attribute specifies whether to notify all group members when a notification is sent.

Example:

{
    "sendChannel": "ding,sms,mail,phone",
    "alarmType": "Contacts",
    "webhookIsAtAll": true
}

Additional information about the MonitorContactsJson parameter

The alert contact configurations. The format of this parameter varies based on the value of the alarmType attribute.

Format

The value of this parameter is in the JSON format. You can specify a contact array or contact group object for this parameter.

Attribute description

If you set the alarmType attribute to Contacts:
- Set this parameter to an array that consists of multiple contact objects. Each object must include the following information:
  - name: the name of the contact.
If you set the alarmType attribute to ContactGroup:
- Set this parameter to an object that includes the following information:
  - name: the name of the contact group.

Examples:

Example 1 (alarmType set to Contacts)

[
    {"name": "Peter"},
    {"name": "Paul"}
]

Example 2 (alarmType set to ContactGroup)

{
    "name": "Alert contact group-1"
}

Examples

Sample success responses

JSONformat

{
  "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,
    "Namespace": "adcfc35d-e2fe-4fe9-bbaa-20e90ffc****",
    "MonitorContactsJson": "\\[ {\"name\": \"Peter\"}, {\"name\": \"Paul\"} ]\n"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-10-27	The response structure of the API has changed	View Change Details
2024-10-17	The response structure of the API has changed	View Change Details
2024-06-05	The response structure of the API has changed	View Change Details
2023-03-30	The internal configuration of the API is changed, but the call is not affected	View Change Details