GetAppApiByPage - Application Real-Time Monitoring Service: Central de Documentação do Alibaba Cloud

Consulta a contagem de solicitações, a contagem de erros e o tempo médio de resposta para cada operação de API em uma aplicação de forma paginada. Você pode determinar se a paginação foi concluída com base no campo Completed na resposta. Se a paginação não estiver concluída, incremente o parâmetro CurrentPage em 1 e envie a solicitação novamente.

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

arms:GetAppApiPageInfo

none

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região.	cn-hangzhou
StartTime	integer	Não	O timestamp da hora de início, com precisão de milissegundos.	1600063200000
EndTime	integer	Não	O timestamp da hora de término, com precisão de milissegundos.	1600066800000
CurrentPage	integer	Não	O número da página dos resultados da consulta.	1
PageSize	integer	Não	[Deprecated] Este parâmetro não é mais suportado. O número de entradas por página. Valor padrão: 10.	10
IntervalMills	integer	Não	O intervalo de tempo das fatias de dados, em milissegundos. Valor mínimo: 60000. Valor máximo: 2147483647.	60000
PId	string	Sim	O ID da aplicação. Na página Monitoramento de Aplicações > Aplicações no console do ARMS, clique no nome da aplicação de destino. A URL na barra de endereços do navegador contém o PID da aplicação no formato pid=xxx. Como o navegador codifica a URL, você deve modificar o PID. Por exemplo, se o PID na URL for xxx%4074xxx, substitua %40 por @. O PID modificado é xxx@74xxx.	a2n80plglh@745eddxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	O código de status. 2XX: Sucesso. 3XX: Redirecionamento. 4XX: Erro do cliente. 5XX: Erro do servidor.	200
Message	string	A mensagem retornada.	message
RequestId	string	O ID da solicitação.	B6A00968-82A8-4F14-9D1B-B53827DB****
Success	boolean	Indica se a consulta foi bem-sucedida. `true`: A consulta foi bem-sucedida. `false`: A consulta falhou.	true
Data	object	A estrutura da resposta.
PageSize	integer	O número de entradas por página.	10
Total	string	O número total de entradas retornadas. Nota O valor deste parâmetro é um valor estimado e é usado apenas para determinar se a paginação foi concluída. Ele não representa o número total real de entradas.	2
Page	integer	O número da página das entradas retornadas.	1
Completed	boolean	Indica se a consulta paginada foi concluída. true: A consulta paginada foi concluída. false: A consulta paginada não foi concluída. Incremente o parâmetro CurrentPage em 1 e envie a solicitação novamente.	false
Items	array<object>	As três métricas de ouro para as operações de API na aplicação.
	object	As três métricas de ouro para a operação de API. `{ "date": 1691051460000, // Hora de ocorrência "rt": 89.61016949152541, // Tempo médio de resposta "rpc": "/api/v1/info", // Operação de API "count": 59, // Contagem de solicitações "error": 1 // Contagem de erros }`	[]

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "message",
  "RequestId": "B6A00968-82A8-4F14-9D1B-B53827DB****",
  "Success": true,
  "Data": {
    "PageSize": 10,
    "Total": "2",
    "Page": 1,
    "Completed": false,
    "Items": [
      []
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
452	OperationTimeOut	The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.	O sistema atingiu o tempo limite ao processar a solicitação atual. Isso pode ocorrer porque a solicitação envolve muitos recursos para o sistema processar dentro do limite de tempo. Ajuste as condições relevantes e tente novamente.
400	ParameterIllegal	The specified parameter is invalid.	O parâmetro é inválido.
400	ParameterRegionIllegal	The specified region is invalid.	O parâmetro region é inválido.
500	InternalError	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.	Ocorreu um erro interno. Tente a operação novamente. Se o erro persistir após várias tentativas, entre em contato com a conta de serviço do DingTalk.
403	RetcodeDailyCustomLimit	Usage today has exceeded the custom limit. The current operation is prohibited.	O uso diário excedeu a cota personalizada. A operação atual não é permitida.
403	RetcodeDailyFreeLimit	Usage today has exceeded the Essential Edition limit. The current operation is prohibited.	O uso diário excedeu o limite da Edição Básica. A operação atual não é permitida.
404	AppNotExist	The application does not exist.	A aplicação não existe.
404	RunningTaskNotExist	Application data collection task does not exist or has been stopped.	A tarefa de coleta de dados do aplicativo não existe ou foi interrompida.
429	OperationIsThrottled	The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.	O serviço de backend não conseguiu processar totalmente a solicitação atual. O resultado retornado pode estar incompleto. Ajuste as condições da operação e tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.