Queries the information about the instance groups of an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
AppId String Query Yes d700e680-aa4d-4ec1-afc2-6566b5ff****

The ID of the application.

CurrentPage Integer Query No 1

The number of the page to return.

PageSize Integer Query No 10

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

The ID of the request.

Message String success

The returned message.

TraceId String 0a98a02315955564772843261e****

The ID of the trace. It is used to query the details of a request.

Data Array of ApplicationGroup

The information about the instance groups of the application.

Jdk String Open JDK 8

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.

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

The address of the image. This parameter is required when the PackageType parameter is set to Image.

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

The address of the deployment package. This parameter is required when the PackageType parameter is set to FatJar, War, or PhpZip.

PackageType String Image

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
PackageVersion String 1.0.0

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.

GroupName String _DEFAULT_GROUP

The name of the group.

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

The ID of the group.

WebContainer String Apache Tomcat 7

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.

Replicas Integer 10

The total number of instances.

EdasContainerVersion String 3.5.3

The version of the container, such as Ali-Tomcat, in which a High-speed Service Framework (HSF) application runs.

RunningInstances Integer 1

The number of running instances.

GroupType Integer 0

The type of the group.

ErrorCode String This parameter is left empty.

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 200

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.
Success Boolean true

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.

Examples

Sample requests

GET /pop/v1/sam/app/describeApplicationGroups?AppId=d700e680-aa4d-4ec1-afc2-6566b5ff****&CurrentPage=1&PageSize=10 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeApplicationGroupsResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <Jdk>Open JDK 8</Jdk>
        <ImageUrl>registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest</ImageUrl>
        <PackageUrl>registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest</PackageUrl>
        <PackageType>Image</PackageType>
        <PackageVersion>1.0.0</PackageVersion>
        <GroupName>_DEFAULT_GROUP</GroupName>
        <GroupId>b2a8a925-477a-eswa-b823-d5e22500****</GroupId>
        <WebContainer>Apache Tomcat 7</WebContainer>
        <Replicas>10</Replicas>
        <EdasContainerVersion>3.5.3</EdasContainerVersion>
        <RunningInstances>1</RunningInstances>
        <GroupType>0</GroupType>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeApplicationGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
  } ],
  "Code" : "200",
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.