All Products
Search
Document Center

SchedulerX:CreateAppGroup

Last Updated:Dec 10, 2024

Creates an application group. The AppKey is returned.

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
edas:CreateSchedulerxAppGroupCreatecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppNamestringYes

The name of the application.

DocTest
NamespacestringYes

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

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

This parameter is not supported. You do not need to specify this parameter.

schedulerx
GroupIdstringYes

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

TestSchedulerx.defaultGroup
RegionIdstringYes

The region ID.

cn-hangzhou
DescriptionstringNo

The description of the application.

Test
MaxJobsintegerNo

The maximum number of jobs.

1000
NamespaceNamestringYes

The name of the namespace.

Test
AppKeystringNo

The AppKey for the application.

adcExHZviLcl****
MonitorConfigJsonstringNo

The configuration of the alert. The value is a JSON string. For more information about this parameter, see Additional information about request parameters.

{"sendChannel":"sms,ding"}
MonitorContactsJsonstringNo

The configuration of alert contacts. The value is a JSON string.

[{"userName":"Tom","userPhone":"89756******"},{"userName":"Bob","ding":"http://www.example.com"}]
ScheduleBusyWorkersbooleanNo

Specifies whether to schedule a busy worker.

false
EnableLogbooleanNo

Specifies whether to enable logging. Valid values:

  • true: enabled
  • false: disabled
true
AppTypeintegerNo

The type of application. Valid values:

  • TRACE: Application Monitoring
  • EBPF: Application Monitoring eBPF Edition
1
AppVersionintegerNo

The application version. 1: Basic version, 2: Professional version.

2

Additional information about request parameters

The following example shows alert notification methods. The methods are separated with commas (,).

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

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

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code.

200
Messagestring

The error message that is returned only if the corresponding error occurs.

Your request is denied as lack of ssl protect.
RequestIdstring

The request ID.

883AFE93-FB03-4FA9-A958-E750C6DE120C
Successboolean

Indicates whether the application was created. Valid values:

  • true
  • false
true
Dataobject

The information about the job group.

AppGroupIdlong

The job group ID.

6607
AppKeystring

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 timeSummary of changesOperation
2024-10-21The response structure of the API has changedView Change Details
2024-06-05The request parameters of the API has changedView Change Details
2024-05-29The request parameters of the API has changedView Change Details
2023-03-30The internal configuration of the API is changed, but the call is not affectedView Change Details
2022-01-13The request parameters of the API has changed. The response structure of the API has changedView Change Details

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 region ID. 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 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));
        }
    }
    
}