DescribeApplicationGroups - - Alibaba Cloud Documentation Center

Queries the instance groups of an application.

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

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribeApplicationGroups	get	All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	d700e680-aa4d-4ec1-afc2-6566b5ff****	d700e680-aa4d-4ec1-afc2-6566b5ff****
CurrentPage	integer	No	1	1
PageSize	integer	No	10	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message.	success
TraceId	string	The ID of the trace. It is used to query the details of a request.	0a98a02315955564772843261e****
Data	array<object>	The information about the instance groups of the application.
ApplicationGroup	object
Jdk	string	The version of the Java development kit (JDK) on which the deployment package of the application depends. This parameter is invalid when the PackageType parameter is set to Image.	Open JDK 8
ImageUrl	string	The address of the image. This parameter is required when the PackageType parameter is set to Image.	registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest
PackageUrl	string	The address of the deployment package. This parameter is required when the PackageType parameter is set to FatJar, War, or PhpZip.	registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest
PackageType	string	The type of the application deployment package. Valid values: When you use a Java package, set this value to FatJar, War, or Image. When you use a PHP package, the following values are valid: 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 of the deployment package. This parameter is required when the PackageType parameter is set to FatJar, War, or PhpZip. The parameter value will be automatically generated when you use an image to deploy the application and specify the ImageUrl parameter.	1.0.0
GroupName	string	The name of the group.	_DEFAULT_GROUP
GroupId	string	The ID of the group.	b2a8a925-477a-eswa-b823-d5e22500****
WebContainer	string	The version of the Apache Tomcat container on which the deployment package of the application depends. This parameter is invalid when the PackageType parameter is set to Image.	Apache Tomcat 7
Replicas	integer	The total number of instances.	10
EdasContainerVersion	string	The version of the container, such as Ali-Tomcat, in which a High-speed Service Framework (HSF) application runs.	3.5.3
RunningInstances	integer	The number of running instances.	1
GroupType	integer	The type of the group.	0
ErrorCode	string	The error code. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request was invalid. 5xx: indicates that a server error occurred.	200
Success	boolean	Indicates whether the information about instance groups of an application was obtained. Valid values: true: indicates that the information was obtained. false: indicates that the information could not be obtained.	true

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation

No change history