All Products
Search
Document Center

SchedulerX:CreateAppGroup

Last Updated:Mar 20, 2026

Creates an app group and returns an AppKey.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:CreateSchedulerxAppGroupCreate

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AppName

string

Yes

The application name.

DocTest

Namespace

string

Yes

The ID of the namespace. You can find this ID on the Namespace page in the console.

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

NamespaceSource

string

No

This parameter is currently unsupported and can be left unspecified.

schedulerx

GroupId

string

Yes

The ID of the application group. You can find this ID on the Application Management page in the console.

TestSchedulerx.defaultGroup

RegionId

string

No

The ID of the region.

cn-hangzhou

Description

string

No

The application description.

Test

MaxJobs

integer

No

The maximum number of jobs.

1000

NamespaceName

string

No

The name of the namespace.

Test

AppKey

string

No

The AppKey of the application.

adcExHZviLcl****

MonitorConfigJson

string

No

Specifies the alert notification configuration as a JSON string. The string can contain the following properties: sendChannel, alarmType, and webhookIsAtAll.

Note

For more information, see the Additional information about request parameters section.

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

MonitorContactsJson

string

No

The alert contacts. This can include individual contacts and contact groups.

Note

For more information, see the Additional information about request parameters section.

[ {"name": "张三"}, {"name": "李四"} ]

ScheduleBusyWorkers

boolean

No

Specifies whether to schedule jobs on a busy worker.

false

EnableLog

boolean

No

Specifies whether to enable logging.

  • true: Enable logging.

  • false: Disable logging.

true

AppType

integer

No

The application type.

  • 1: Standard application.

  • 2: Kubernetes (K8s) application.

1

AppVersion

integer

No

The application version. Valid values: 1 (Basic Edition) and 2 (Professional Edition).

2

NotificationPolicyName

string

No

The notification policy name.

test-workday-notification

MonitorConfigJson

Configures alarm notifications. It supports the following properties: sendChannel, alarmType, and webhookIsAtAll.

Configuration format

The value must be a JSON object with the following properties:

Properties

  • Notification channel (sendChannel):

    • Specify one or more notification channels, separated by commas. Valid options are:
      • webhook: ding

      • SMS: sms

      • Email: mail

      • Phone Call: phone

  • Alarm Type (alarmType):

    • Contacts: The recipients are Alarm Contacts.

    • ContactGroup: The recipient is an Alarm Contact Group.

  • Mention all members (webhookIsAtAll):

    • Set to true to @mention all members in a group notification, or false otherwise.

Example

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

MonitorContactsJson

Configures Alarm Contacts. The format of this JSON object depends on the value of alarmType.

Configuration format

The value is a JSON payload that is either an array of contact objects or a single contact group object.

Properties

  • When alarmType is Contacts:

    • The value is an array of contact objects, where each object must contain the following property:
      • name: The name of the contact.

  • When alarmType is ContactGroup:

    • The value is a single object that contains the following property:
      • name: The name of the contact group.

Important

We recommend creating Alarm Contacts and Alarm Contact Groups in advance. If a specified contact or contact group does not exist, the system automatically creates it. You must then configure the contact's phone number, email address, and other details on the Notification Contacts page and activate the contact to ensure Alarm Notifications are sent correctly.

Examples

  • Example 1 (When alarmType is Contacts):

    [
        {"name": "John Smith"},
        {"name": "Jane Doe"}
    ]
    
  • Example 2 (When alarmType is ContactGroup):

    {
        "name": "Alarm-Contact-Group-1"
    }
    

Response elements

Element

Type

Description

Example

object

Code

integer

The return code.

200

Message

string

The error message. Returned only when the request fails.

Your request is denied as lack of ssl protect.

RequestId

string

The unique identifier for the request.

883AFE93-FB03-4FA9-A958-E750C6DE120C

Success

boolean

Indicates whether the Application Group was successfully created. Valid values:

  • true: The Application Group was successfully created.

  • false: The Application Group failed to be created.

true

Data

object

Information about the created Application Group.

AppGroupId

integer

The Application Group ID.

6607

AppKey

string

The Application Key (AppKey).

adcExHZviL******

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Your request is denied as lack of ssl protect.",
  "RequestId": "883AFE93-FB03-4FA9-A958-E750C6DE120C",
  "Success": true,
  "Data": {
    "AppGroupId": 6607,
    "AppKey": "adcExHZviL******"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.