ListGroups-阿里云帮助中心

Retrieves a list of application groups.

Operation description

Before you call this operation, add the following dependency to your POM file:

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

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:ReadSchedulerxAppGroupQuery

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
Code	integer	The status code.	200
Message	string	The response message.	message
RequestId	string	The request ID.	71BCC0E3-64B2-4B63-A870-AFB64EBCB58A
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The data returned.
AppGroups	array<object>	The list of application groups.
	object
AppGroupId	integer	The application group ID.	1
AppName	string	The application name.	DocTest
AppKey	string	The application key.	a3G77O6NZxq/lyo1NC****==
Description	string	The application description.	Test
GroupId	string	The application ID.	DocTest.Group
AppVersion	integer	The application edition. Valid values: 1: Basic Edition, 2: Professional Edition.	2
Namespace	string	The namespace ID.	1a72ecb1-b4cc-400a-a71b-20cdec9b****
EnableLog	boolean	Indicates whether logging is enabled. Valid values: true: enabled false: disabled	false

Examples

Success response

JSON format

{
  "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****",
        "EnableLog": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.