ListGroups - SchedulerX - Alibaba Cloud Documentation Center

Queries a list of applications.

Operation description

Before you call this operation, you must add the following dependency to the pom.xml file:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-schedulerx2</artifactId>
    <version>1.0.5</version>
</dependency>

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadSchedulerxAppGroupQuery	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.	1a72ecb1-b4cc-400a-a71b-20cdec9b****
NamespaceSource	string	No	The source of the namespace. This parameter is required only for a special third party.	schedulerx
RegionId	string	Yes	The region ID.	cn-hangzhou
AppGroupName	string	No	The name of the application group.	k8s-test

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code.	200
Message	string	The returned message.	message
RequestId	string	The request ID.	71BCC0E3-64B2-4B63-A870-AFB64EBCB58A
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The applications.
AppGroups	array<object>	The applications and their details.
AppGroup	object
AppGroupId	long	The application group ID.	1
AppName	string	The name of the application.	DocTest
AppKey	string	The AppKey for the application.	a3G77O6NZxq/lyo1NC****==
Description	string	The description of the application.	Test
GroupId	string	The application ID.	DocTest.Group
AppVersion	integer	The application version. 1: Basic version, 2: Professional version.	2
Namespace	string	The ID of the namespace.	1a72ecb1-b4cc-400a-a71b-20cdec9b****

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "message",
  "RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB58A",
  "Success": true,
  "Data": {
    "AppGroups": [
      {
        "AppGroupId": 1,
        "AppName": "DocTest",
        "AppKey": "a3G77O6NZxq/lyo1NC****==",
        "Description": "Test",
        "GroupId": "DocTest.Group",
        "AppVersion": 2,
        "Namespace": "1a72ecb1-b4cc-400a-a71b-20cdec9b****"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-10-18	The response structure of the API has changed	View Change Details
2024-06-05	The response structure of the API has changed	View Change Details
2024-05-29	The response structure of the API has changed	View Change Details
2023-03-30	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-03-01	The request parameters of the API has changed	View Change Details

Sample code

package com.alibaba.schedulerx.pop;

import java.util.List;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.ListGroupsRequest;
import com.aliyuncs.schedulerx2.model.v20190430.ListGroupsResponse;
import com.aliyuncs.schedulerx2.model.v20190430.ListGroupsResponse.Data.AppGroup;

public class TestListGroups {

    public static void main(String[] args) {
        // 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-hangzhou";
        // The AccessKey ID that is used for authentication. You can obtain the AccessKey ID in the RAM console. 
        String accessKeyId = "XXXXXXXX";
        // The AccessKey secret that is used for authentication. You can obtain the AccessKey secret in the RAM console. 
        String accessKeySecret = "XXXXXXXX";
        // The name of the service. 
        String productName ="schedulerx2";
        // The domain. Enter a domain by referring to the Endpoints topic. 
        String domain ="schedulerx.cn-hangzhou.aliyuncs.com";
        // Build an API client. 
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        ListGroupsRequest request = new ListGroupsRequest();
        // The namespace ID. 
        request.setNamespace("433d8b23-06e9-408c-aaaa-90d4d1b9****");
        ListGroupsResponse response;
        try {
            response = client.getAcsResponse(request);
            if (!response.getSuccess()) {
                System.out.println(response.getMessage());
            } else {
                List<AppGroup> appGroups = response.getData().getAppGroups();
                for (AppGroup appGroup : appGroups) {
                    System.out.println("groupId=" + appGroup.getGroupId() + ", appKey=" + appGroup.getAppKey());
                }
            }
        } catch (ServerException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (ClientException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
    
}