All Products
Search
Document Center

Serverless App Engine:DescribeApplicationGroups

Last Updated:Oct 26, 2026

Queries application instance groups.

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

sae:DescribeApplicationGroups

get

*All Resource

*

None None

Request syntax

GET /pop/v1/sam/app/describeApplicationGroups HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AppId

string

Yes

The application ID.

d700e680-aa4d-4ec1-afc2-6566b5ff****

CurrentPage

integer

No

The page number.

1

PageSize

integer

No

The page size.

10

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

Message

string

The additional information about the call result.

success

TraceId

string

The trace ID used to precisely query call information.

0a98a02315955564772843261e****

Data

array<object>

The application group information.

object

Jdk

string

The JDK version on which the deployment package depends. This parameter is not supported when Package Type is set to Image.

Open JDK 8

ImageUrl

string

The image address. This parameter is required when Package Type is set to Image.

registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest

PackageUrl

string

The deployment package address. This parameter is required when Package Type is set to FatJar, War, or PhpZip.

registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest

PackageType

string

The application package type. Valid values:

  • If you deploy the application by using Java, valid values are FatJar, War, and Image.

  • If you deploy the application by using PHP, valid values are:
    • PhpZip

    • IMAGE_PHP_5_4

    • IMAGE_PHP_5_4_ALPINE

    • IMAGE_PHP_5_5

    • IMAGE_PHP_5_5_ALPINE

    • IMAGE_PHP_5_6

    • IMAGE_PHP_5_6_ALPINE

    • IMAGE_PHP_7_0

    • IMAGE_PHP_7_0_ALPINE

    • IMAGE_PHP_7_1

    • IMAGE_PHP_7_1_ALPINE

    • IMAGE_PHP_7_2

    • IMAGE_PHP_7_2_ALPINE

    • IMAGE_PHP_7_3

    • IMAGE_PHP_7_3_ALPINE

Image

PackageVersion

string

The version number of the deployment package. This parameter is required when Package Type is set to FatJar, War, or PhpZip. If the application is deployed by using ImageUrl, this parameter is automatically generated.

1.0.0

PackageVersionId

string

The version ID of the deployment package.

12345678-1234-4abc-8def-1234567890ab

GroupName

string

The group name.

_DEFAULT_GROUP

GroupId

string

The group ID.

b2a8a925-477a-eswa-b823-d5e22500****

WebContainer

string

The Tomcat version on which the deployment package depends. This parameter is not supported when Package Type is set to Image.

Apache Tomcat 7

Replicas

integer

The total number of instances.

10

EdasContainerVersion

string

The application runtime environment version in the HSF framework, such as the Ali-Tomcat container.

3.5.3

RunningInstances

integer

The number of running instances.

1

GroupType

integer

The group type.

0

ErrorCode

string

The error code. Valid values:

  • If the request is successful, the ErrorCode parameter is not returned.

  • If the request fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.

Code

string

The API status code or POP error code. Valid values:

  • 2xx: success

  • 3xx: redirection

  • 4xx: request error

  • 5xx: server error

200

Success

boolean

Indicates whether the application instance groups were retrieved successfully. Valid values:

  • true: The application instance groups were retrieved successfully.

  • false: The application instance groups failed to be retrieved.

true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "Jdk": "Open JDK 8",
      "ImageUrl": "registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest",
      "PackageUrl": "registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest",
      "PackageType": "Image",
      "PackageVersion": "1.0.0",
      "PackageVersionId": "12345678-1234-4abc-8def-1234567890ab",
      "GroupName": "_DEFAULT_GROUP",
      "GroupId": "b2a8a925-477a-eswa-b823-d5e22500****",
      "WebContainer": "Apache Tomcat 7",
      "Replicas": 10,
      "EdasContainerVersion": "3.5.3",
      "RunningInstances": 1,
      "GroupType": 0
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.