GetApplicationGroup - CloudOps Orchestration Service: Central de Documentação do Alibaba Cloud

Obtém os detalhes de um grupo de aplicativos. O serviço de gerenciamento de aplicativos está disponível apenas na região China (Hangzhou). Use o endpoint de Hangzhou.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

oos:GetApplicationGroup

get

*ApplicationGroup

acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}

oos:TLSVersion

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região. Apenas cn-hangzhou é suportado.	cn-hangzhou
Name	string	Sim	O nome do grupo de aplicativos.	MeuGrupoDeAplicativos
ApplicationName	string	Sim	O nome do aplicativo.	MeuAplicativo
ShowMonitorURL	boolean	Não	Especifica se a URL de monitoramento do aplicativo deve ser retornada.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ApplicationGroup	object	Os detalhes do grupo de aplicativos.
ApplicationName	string	O nome do aplicativo.	MeuAplicativo
ApplicationSource	string	A origem do aplicativo.	{"Platform":"github","RepoName":"xxx/springboot-ecs-sourcecode-demo","Owner":"xxx","Branch":"main","CommitHash":"8559ff3xxxxxxxxxf06c6fe","CommitMessage":"Iniciar projeto computenest"}
CmsGroupId	string	O ID do grupo do CloudMonitor.	12345678
CreateDate	string	A hora em que o grupo de aplicativos foi criado.	2021-09-07T10:28:25Z
DeployOutputs	string	As saídas do resultado da implantação.	{ "Outputs": [ { "Description": "Nenhuma descrição fornecida", "OutputKey": "InstanceIds" } ], "StackId": "6ef4b860-f6e7-4145-8d22-f4a2a32363e1" }
DeployParameters	string	As informações de configuração do grupo de aplicativos.	{ "TemplateURL": "https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json", "Parameters": { "ZoneId": "cn-hangzhou-k", "ProjectName": "teste", "SystemDiskSize": 40, "InstanceChargeType": "PostPaid", "SecurityGroupId": "sg-bp1a4374akk63jl8tddy", "VSwitchId": "vsw-bp1fcvc3zn0jrag86rrlm", "SystemDiskCategory": "cloud_essd", "InstancePassword": "******", "InternetChargeType": "PayByTraffic", "InstanceCount": 1, "InternetMaxBandwidthOut": 0, "VpcId": "vpc-bp1i99boyas8i8m9t3skp", "EcsImageId": "centos_8_5_x64_20G_alibase_20211228.vhd", "DataDiskSize": 100, "EcsInstanceType": "ecs.s6-c1m4.small", "DataDiskCategory": "cloud_efficiency", "EnvironmentCommandId": "c-hz028fc3g031gcg" } }
DeployRegionId	string	O ID da região de implantação.	cn-hangzhou
DeployedRevisionIds	string	A lista de IDs das revisões implantadas. Apenas as 10 revisões implantadas mais recentemente são exibidas.	["rev-f575b688015442d28d26","rev-b9876a39cf84490db638","rev-782fc7a0c0974d89b1eb"]
Description	string	A descrição do grupo de aplicativos.	GrupoDeAplicativos
ErrorDetail	string	Os detalhes do erro da falha de compilação.	ERRO: falha ao compilar: executando ciclo de vida: falhou com o código de status: 51
ErrorType	string	O tipo de erro da falha de compilação.	Compilação
ExecutionId	string	O ID de execução.	exec-f5dee943869c436a9f57
ImportTagKey	string	A chave da tag.	k1
ImportTagValue	string	O valor da tag.	v1
MonitorMetadata	string	Os metadados de monitoramento.	[{"CmsProject":"workspace1","CmsApplicationName":"padrão"}]
MonitorURL	string	A URL de monitoramento.	http//xxx.com
Name	string	O nome do grupo de aplicativos.	MeuGrupoDeAplicativos
OperationMetadata	string	A configuração de O&M gerenciado.	{\"PrometheusConfigMap\":{\"template1\":{\"EnablePrometheus\":false}}}
Progress	string	O progresso da criação da instância do aplicativo.	100
Status	string	O status do grupo de aplicativos.	Criado
StatusReason	string	Os detalhes do status do grupo de aplicativos.	Criação da stack concluída com sucesso
UpdateDate	string	A hora em que o grupo de aplicativos foi atualizado pela última vez.	2021-09-07T10:28:25Z
RequestId	string	O ID da solicitação.	92EA60ED-544D-55E9-93D9-237BE9976C0D

Exemplos

Resposta de sucesso

JSON formato

{
  "ApplicationGroup": {
    "ApplicationName": "MyApplication",
    "ApplicationSource": "{\"Platform\":\"github\",\"RepoName\":\"wenle/springboot-ecs-sourcecode-demo\",\"Owner\":\"wenle\",\"Branch\":\"main\",\"CommitHash\":\"8559ff3ac7568fc7951ff63f841883ee3f06c6fe\",\"CommitMessage\":\"Iniciar projeto computenest\"}",
    "CmsGroupId": "12345678",
    "CreateDate": "2021-09-07T10:28:25Z",
    "DeployOutputs": "{       \"Outputs\": [         {           \"Description\": \"Nenhuma descrição fornecida\",           \"OutputKey\": \"InstanceIds\"         }       ],       \"StackId\": \"6ef4b860-f6e7-4145-8d22-f4a2a32363e1\"     }   }",
    "DeployParameters": "{       \"TemplateURL\": \"https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json\",       \"Parameters\": {         \"ZoneId\": \"cn-hangzhou-k\",         \"ProjectName\": \"teste\",         \"SystemDiskSize\": 40,         \"InstanceChargeType\": \"PostPaid\",         \"SecurityGroupId\": \"sg-bp1a4374akk63jl8tddy\",         \"VSwitchId\": \"vsw-bp1fcvc3zn0jrag86rrlm\",         \"SystemDiskCategory\": \"cloud_essd\",         \"InstancePassword\": \"******\",         \"InternetChargeType\": \"PayByTraffic\",         \"InstanceCount\": 1,         \"InternetMaxBandwidthOut\": 0,         \"VpcId\": \"vpc-bp1i99boyas8i8m9t3skp\",         \"EcsImageId\": \"centos_8_5_x64_20G_alibase_20211228.vhd\",         \"DataDiskSize\": 100,         \"EcsInstanceType\": \"ecs.s6-c1m4.small\",         \"DataDiskCategory\": \"cloud_efficiency\",         \"EnvironmentCommandId\": \"c-hz028fc3g031gcg\"       }",
    "DeployRegionId": "cn-hangzhou",
    "DeployedRevisionIds": "[\"rev-f575b688015442d28d26\",\"rev-b9876a39cf84490db638\",\"rev-782fc7a0c0974d89b1eb\"]",
    "Description": "ApplicationGroup",
    "ErrorDetail": "ERROR: failed to build: executing lifecycle: failed with status code: 51",
    "ErrorType": "Build",
    "ExecutionId": "exec-f5dee943869c436a9f57",
    "ImportTagKey": "k1",
    "ImportTagValue": "v1",
    "MonitorMetadata": "[{\"CmsProject\":\"workspace1\",\"CmsApplicationName\":\"default\"}]",
    "MonitorURL": "http//xxx.com",
    "Name": "MyApplicationGroup",
    "OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"template1\\\":{\\\"EnablePrometheus\\\":false}}}",
    "Progress": "100",
    "Status": "Created",
    "StatusReason": "Stack CREATE completed successfully",
    "UpdateDate": "2021-09-07T10:28:25Z"
  },
  "RequestId": "92EA60ED-544D-55E9-93D9-237BE9976C0D"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.