CreateAppGroup - SchedulerX - Alibaba Cloud Documentation Center

Creates an application group and returns the AppKey.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AppName	string	Yes	The name of the application.	DocTest
Namespace	string	Yes	The ID of the namespace. You can obtain the ID of the namespace on the Namespace page in Distributed Task Scheduling Platform.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	No	This parameter is not supported. You do not need to specify this parameter.	schedulerx
GroupId	string	Yes	The application ID. You can obtain the application ID on the Application Management page in Distributed Task Scheduling Platform.	TestSchedulerx.defaultGroup
RegionId	string	Yes	The ID of the region.	cn-hangzhou
Description	string	No	The description of the application.	Test
MaxJobs	integer	No	The maximum number of jobs.	1000
NamespaceName	string	Yes	The name of the custom namespace.	Test
AppKey	string	No	The AppKey for the application.	adcExHZviLcl****
MonitorConfigJson	string	No	The configuration of the alert. The value is a JSON string. For more information about this parameter, see the Additional information about request parameters section of this topic.	{"sendChannel":"sms,ding"}
MonitorContactsJson	string	No	The configuration of alert contacts. The value is a JSON string.	\[{"userName":"Tom","userPhone":"89756\\\\\\"},{"userName":"Bob","ding":"http://www.example.com"}]
ScheduleBusyWorkers	boolean	No	Specifies whether to schedule a busy worker.	false
EnableLog	boolean	No	Specifies whether to enable the logging feature. true: enables the logging feature. false: disables the logging feature.	true
AppType	integer	No	The type of the application. Valid values: 1: a common application 2: a Kubernetes application	1

Additional information about request parameters

The following content shows the notification methods for alerts. If you want to specify multiple methods, separate these methods with commas (,).

Webhook: ding
SMS: sms
Email: mail
TEL: phone

Example: {"sendChannel":"ding,sms,mail,phone"}

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	200
Message	string	The error message that is returned if an error occurs.	Your request is denied as lack of ssl protect.
RequestId	string	The ID of the request.	883AFE93-FB03-4FA9-A958-E750C6DE120C
Success	boolean	Indicates whether an application was created. Valid values: true: The application was created. false: The application failed to be created.	true
Data	object	The information about the job group.
AppGroupId	long	The ID of the job group.	6607
AppKey	string	The AppKey for the application.	adcExHZviL******

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time

Summary of changes

Operation

2022-01-13

The input parameters of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: AppKey
	Added Input Parameters: MonitorConfigJson
	Added Input Parameters: MonitorContactsJson
Output Parameters	The response structure of the API operation changes.

Sample code

package com.alibaba.schedulerx.pop;

import com.alibaba.schedulerx.common.util.JsonUtil;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.CreateAppGroupRequest;
import com.aliyuncs.schedulerx2.model.v20190430.CreateAppGroupResponse;

public class TestCreateAppGroup {

    public static void main(String[] args) throws Exception {
        // The ID of the region. Enter a value by referring to the Endpoints topic or based on the region in which you purchased the service. 
        String regionId = "cn-shanghai";
        // The AccessKey ID that is used for authentication. You can obtain the AccessKey ID in the Resource Access Management (RAM) console. 
        String accessKeyId = "<yourAccessKeyId>";
        // The AccessKey secret that is used for authentication. You can obtain the AccessKey secret in the RAM console. 
        String accessKeySecret = "<yourAccessKeySecret>";
        // The name of the service.
        String productName ="schedulerx2";
        // The domain. Enter a domain by referring to the Endpoints topic. 
        String domain ="schedulerx.cn-shanghai.aliyuncs.com";
        // Build an API client. 
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        CreateAppGroupRequest request = new CreateAppGroupRequest();
        request.setNamespace("xxxxxx");
        request.setNamespaceName("xxxx");
        request.setAppName("xxxx");
        request.setDescription("xxx");
        request.setGroupId("xxx");

        // Send a request. 
        CreateAppGroupResponse response = client.getAcsResponse(request);
        if (!response.getSuccess()) {
            System.out.println(response.getMessage());
            System.out.println("createApp: "+response.getRequestId());
        } else {
            System.out.println(JsonUtil.toJson(response));
        }
    }
    
}