Todos os produtos
Search
Central de documentação

:DescribeApplicationGroups

Última atualização: Jul 09, 2026

Consulta informações sobre os grupos de instâncias de uma aplicação.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte Parâmetros de requisição comuns e parâmetros de resposta comuns.

Sintaxe da requisição

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

Parâmetros da requisição

Parâmetro

Tipo

Posição

Obrigatório

Exemplo

Descrição

AppId

String

Query

Sim

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

ID da aplicação.

CurrentPage

Integer

Query

Não

1

Número da página a retornar.

PageSize

Integer

Query

Não

10

Quantidade de entradas a retornar por página.

Parâmetros de resposta

ParâmetroTipoExemploDescrição
RequestIdString91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

ID da requisição.

MessageStringsuccess

Mensagem retornada.

TraceIdString0a98a02315955564772843261e****

ID do rastreamento. Serve para consultar detalhes de uma requisição.

DataArray of ApplicationGroup

Informações sobre os grupos de instâncias da aplicação.

JdkStringOpen JDK 8

Versão do Java Development Kit (JDK) exigida pelo pacote de implantação da aplicação. Este parâmetro torna-se inválido se PackageType estiver definido como Image.

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

Endereço da imagem. Obrigatório quando PackageType for Image.

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

Endereço do pacote de implantação. Obrigatório quando PackageType for FatJar, War ou PhpZip.

PackageTypeStringImage

Tipo do pacote de implantação da aplicação. Valores válidos:

  • Pacotes Java: defina como FatJar, War ou Image.
  • Pacotes PHP aceitam os seguintes valores:
    • 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
PackageVersionString1.0.0

Versão do pacote de implantação. Obrigatório quando PackageType for FatJar, War ou PhpZip. O sistema gera esse valor automaticamente ao implantar a aplicação via imagem com o parâmetro ImageUrl especificado.

GroupNameString_DEFAULT_GROUP

Nome do grupo.

GroupIdStringb2a8a925-477a-eswa-b823-d5e22500****

ID do grupo.

WebContainerStringApache Tomcat 7

Versão do contêiner Apache Tomcat exigida pelo pacote de implantação da aplicação. Este parâmetro torna-se inválido se PackageType estiver definido como Image.

ReplicasInteger10

Número total de instâncias.

EdasContainerVersionString3.5.3

Versão do contêiner (como Ali-Tomcat) onde a aplicação High-speed Service Framework (HSF) é executada.

RunningInstancesInteger1

Quantidade de instâncias em execução.

GroupTypeInteger0

Tipo do grupo.

ErrorCodeStringEste parâmetro é deixado vazio.

Código de erro.

  • O parâmetro ErrorCode não retorna valor em requisições bem-sucedidas.
  • O parâmetro ErrorCode retorna valor quando a requisição falha. Para mais informações, consulte Códigos de erro neste tópico.
CodeString200

Código de status HTTP. Valores válidos:

  • 2xx: requisição bem-sucedida.
  • 3xx: requisição redirecionada.
  • 4xx: requisição inválida.
  • 5xx: erro no servidor.
SuccessBooleantrue

Indica se as informações sobre os grupos de instâncias da aplicação foram obtidas. Valores válidos:

  • true: informações obtidas com sucesso.
  • false: falha ao obter as informações.

Exemplos

Exemplos de requisições

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

Exemplos de respostas de sucesso

Formato XML

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>

Formato JSON

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
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.