UpdateAppGroup
Update the application group.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
edas:ManageSchedulerxAppGroupModify |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Description |
string |
No |
The description of the application. |
Test |
| 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 |
| MaxConcurrency |
integer |
No |
The maximum number of concurrent instances. Default value: 1. A value of 1 specifies that if the last triggered instance is running, the next instance is not triggered even if the scheduled point in time for running the next instance is reached. |
1 |
| 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 |
Yes |
The ID of the region. |
cn-hangzhou |
| AppVersion |
integer |
No |
The application version. 1: Basic version, 2: Professional version. |
2 |
| MonitorConfigJson |
string |
No |
The configuration of the alert. The value is a JSON string. For more information about this parameter, see Additional information about request parameters. |
{ "sendChannel": "ding,sms,mail,phone", "alarmType": "Contacts", "webhookIsAtAll": false } |
| MonitorContactsJson |
string |
No |
The configuration of alert contacts. The value is a JSON string. |
[ {"name": "Alice Johnson"}, {"name": "Lee Smith"} ] |
| NotificationPolicyName |
string |
No |
Notification policy name |
test-workday-notification |
| EnableLog |
boolean |
No |
Enable logging |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The schema of the response. |
||
| RequestId |
string |
The ID of the request. |
4F68ABED-AC31-4412-9297-D9A8F0401108 |
| Code |
integer |
The HTTP status code 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 |
Additional Notes for MonitorConfigJson
The configuration for alert notifications supports the following properties: sendChannel, alarmType, and webhookIsAtAll.
Configuration Format
This field must be in JSON format and supports the following properties:
Property Descriptions
-
Sending Channel (
sendChannel):- Supports multiple channels, separated by commas. Available options include:
webhook:
dingtext message:
smsEmail:
mailPhone:
phone
- Supports multiple channels, separated by commas. Available options include:
-
Alarm Type (
alarmType):Contacts: indicates alert contacts
ContactGroup: indicates an alert contact group
-
Whether to @ All Members (
webhookIsAtAll):The value is either
"true"or"false", indicating whether to @ all members in the group when sending a notification.
Sample:
{
"sendChannel": "ding,sms,mail,phone",
"alarmType": "Contacts",
"webhookIsAtAll": true
}
Additional Notes for MonitorContactsJson
The alert contact configuration provides two formats depending on the value of alarmType.
Configuration Format
This field must be in JSON format and supports two configurations: an array of contacts or a contact group object.
Property Descriptions
-
When
alarmTypeisContacts:- Configure as an array containing multiple contact objects. Each object must include:
name: The name of the contact
- Configure as an array containing multiple contact objects. Each object must include:
-
When
alarmTypeisContactGroup:- Configure as a single object containing:
name: The name of the contact group
- Configure as a single object containing:
Notes
We recommend creating contacts and contact groups in advance. If they are not created beforehand, the system will automatically generate the corresponding contacts and contact groups. You must configure contact information such as phone numbers and email addresses and activate them on the Notifications Contacts page to ensure that alerts can be sent normally.
Sample:
-
Sample 1 (when
alarmTypeisContacts):[ {"name": "Zhang San"}, {"name": "Li Si"} ] -
Sample 2 (when
alarmTypeisContactGroup):{ "name": "alert contact group-1" }
Examples
Success response
JSON format
{
"RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
"Code": 200,
"Message": "app is not existed, groupId=xxxx, namesapce=xxxx",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.