文档

DescribeApplicationGroups - 获取应用实例分组

更新时间:

调用DescribeApplicationGroups接口获取应用实例分组。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:DescribeApplicationGroupsget
  • 全部资源
    *

请求语法

GET /pop/v1/sam/app/describeApplicationGroups

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

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

页码。

1
PageSizeinteger

页面大小。

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

调用结果的附加信息。

success
TraceIdstring

调用链 ID,用于精确查询调用信息。

0a98a02315955564772843261e****
Dataarray<object>

应用分组信息。

object
Jdkstring

部署包依赖的 JDK 版本。当Package TypeImage 时不支持。

Open JDK 8
ImageUrlstring

镜像地址。当Package TypeImage 时必填。

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

部署包地址。当Package TypeFatJarWarPhpZip 时必填。

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

应用包类型。取值说明如下:

  • 当您选择用 Java 部署时,支持 FatJarWarImage
  • 当您选择用 PHP 部署时,支持类型如下:
    • 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
PackageVersionstring

部署包的版本号。当Package TypeFatJarWarPhpZip 时必填。若为 ImageUrl 部署,则自动生成。

1.0.0
GroupNamestring

分组名称。

_DEFAULT_GROUP
GroupIdstring

分组 ID。

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

部署包依赖的 Tomcat 版本。当Package TypeImage 时不支持。

Apache Tomcat 7
Replicasinteger

所有实例数。

10
EdasContainerVersionstring

HSF 框架中应用运行环境版本,例如 Ali-Tomcat 容器。

3.5.3
RunningInstancesinteger

运行中的实例数。

1
GroupTypeinteger

分组类型。

0
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码目录。
Codestring

接口状态或 POP 错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

获取应用实例分组是否成功。取值说明如下:

  • true:表示获取成功。
  • false:表示获取失败。
true

示例

正常返回示例

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史