All Products
Search
Document Center

SchedulerX:CreateAppGroup

Last Updated:Oct 12, 2026

Creates an application group and returns the 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 name of the application.

DocTest

Namespace

string

Yes

The namespace ID. You can obtain the ID on the Namespaces page in the console.

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

NamespaceSource

string

No

This parameter is not supported. Leave it empty.

schedulerx

GroupId

string

Yes

The application ID. You can obtain the ID on the Application Management page in the console.

TestSchedulerx.defaultGroup

RegionId

string

No

The region ID.

cn-hangzhou

Description

string

No

The description of the application.

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

The configuration of alert notifications. The following properties are supported: sendChannel, alarmType, and webhookIsAtAll.

Note

For more information about this field, see Supplementary description of request parameters below.

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

MonitorContactsJson

string

No

The configuration of alert contacts. You can configure alert contacts and alert contact groups.

Note

For more information about this field, see Supplementary description of request parameters below.

[ {"name": "Alice Johnson"}, {"name": "Lee Smith"} ]

ScheduleBusyWorkers

boolean

No

Specifies whether to schedule tasks on busy workers.

false

EnableLog

boolean

No

Specifies whether to enable logging. Valid values:

  • true: Enabled.

  • false: Disabled.

true

AppType

integer

No

The application type. Valid values:

  • 1: Common application.

  • 2: Kubernetes application.

1

AppVersion

integer

No

The application version. Valid values:

  • 1: Basic Edition.

  • 2: Professional Edition.

Valid values:

  • 1 :

    Basic Edition.

  • 2 :

    Professional Edition.

2

NotificationPolicyName

string

No

The notification policy name.

test-workday-notification

Supplementary description of MonitorConfigJson

The configuration of alert notifications. The following properties are supported: sendChannel, alarmType, and webhookIsAtAll.

Configuration format

The configuration of this field must be in JSON format and supports the following properties:

Property description

  • Send channel (sendChannel):

    • Multiple channels are supported. Separate them with commas. Valid values:
      • webhook: ding

      • SMS: sms

      • Email: mail

      • Phone: phone

  • Alert type (alarmType):

    • Contacts: indicates alert contacts.

    • ContactGroup: indicates an alert contact group.

  • Whether to @ all members (webhookIsAtAll):

    • The value is "true" or "false", which indicates whether to @ all group members when sending notifications.

Example:

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

Supplementary description of MonitorContactsJson

The configuration of alert contacts. Two formats are provided based on the value of alarmType.

Configuration format

This field must be in JSON format and supports two configurations: an array of contacts and a contact group object.

Property description

  • When alarmType is Contacts:

    • Configure it as an array containing multiple contact objects. Each object must include:
      • name: the name of the contact.

  • When alarmType is ContactGroup:

    • Configure it as a single object that includes:
      • name: the name of the contact group.

Precautions

Create contacts and contact groups in advance. If they are not created, the system automatically generates the corresponding contacts and contact groups. You must configure and activate the mobile phone numbers and email addresses of the contacts on the Notification Contacts page to ensure that alerts can be sent properly.

Examples:

  • Example 1 (when alarmType is Contacts):

    [
        {"name": "Zhang San"},
        {"name": "Li Si"}
    ]
    
  • Example 2 (when alarmType is ContactGroup):

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

Response elements

Element

Type

Description

Example

object

Code

integer

The return code.

200

Message

string

The error message. This parameter is returned only when an error occurs.

Your request is denied as lack of ssl protect.

RequestId

string

The unique ID of the request.

883AFE93-FB03-4FA9-A958-E750C6DE120C

Success

boolean

Indicates whether the application was created successfully. Valid values:

  • true: The application was created successfully.

  • false: The application failed to be created.

true

Data

object

The application group information.

AppGroupId

integer

The application group ID.

6607

AppKey

string

The AppKey of the application.

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.