DescribeUrlObservationData - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Consulta os dados de monitoramento da página.

Descrição da operação

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

esa:DescribeUrlObservationData

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Nenhuma

Sintaxe da solicitação

POST / HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	string	Sim	O ID do site, que pode ser obtido chamando a operação ListSites.	54362329990032
StartTime	string	Não	O início do intervalo de tempo a ser consultado. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.	2023-04-08T16:00:00Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2023-04-19T15:59:59Z
Url	string	Não	A URL da página da web a ser monitorada.	example.com/test
ClientPlatform	string	Não	A plataforma do dispositivo. Se o parâmetro for deixado em branco, todos os dispositivos serão consultados. PC Mobile	PC
Metric	string	Não	Os dados das métricas detectadas. TTFB: Mede o tempo entre o momento em que um recurso inicia uma solicitação e o momento em que o primeiro byte da resposta começa a chegar. FCP: Mede o tempo entre o momento em que a página é carregada e o momento em que qualquer parte do conteúdo da página é renderizada na tela. LCP: Relata o tempo de renderização da maior imagem ou bloco de texto visível na viewport. CLS: Mede a pontuação máxima de mudança de layout para cada mudança inesperada de layout que ocorre ao longo do ciclo de vida da página. INP: Mede a capacidade de resposta da página, ou quanto tempo leva para a página responder à entrada do usuário de forma visível. FID: Mede o tempo entre o momento em que o usuário interage pela primeira vez com a página e o momento em que o navegador é realmente capaz de começar a processar o manipulador de eventos em resposta a essa interação.	TTFB

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
UrlDetailData	array<object>	Os objetos retornados.
	object
Url	string	A URL da página da web a ser monitorada.	example.com/test
ClientPlatform	string	A plataforma do dispositivo.	PC
Country	string	O país ou a região à qual o endereço IP pertence.	CN
TTFB	number	Mede o tempo entre o momento em que um recurso inicia uma solicitação e o momento em que o primeiro byte da resposta começa a chegar. Unidade: ms.	123
FCP	number	Mede o tempo entre o momento em que a página é carregada e o momento em que qualquer parte do conteúdo da página é renderizada na tela. Unidade: ms.	123
LCP	number	Relata o tempo de renderização da maior imagem ou bloco de texto visível na viewport. Unidade: ms.	123
CLS	number	Mede a pontuação máxima de mudança de layout para cada mudança inesperada de layout que ocorre ao longo do ciclo de vida da página.	0.5
FID	number	Mede o tempo entre o momento em que o usuário interage pela primeira vez com a página e o momento em que o navegador é realmente capaz de começar a processar um manipulador de eventos em resposta a essa interação. Unidade: ms.	123
INP	number	Mede a capacidade de resposta da página, ou quanto tempo leva para a página responder à entrada do usuário de forma visível. Unidade: ms.	123
RequestId	string	O ID da solicitação.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
StartTime	string	A hora de criação. O horário está no formato yyyy-MM-ddTHH:mm:ssZ.	2022-11-06T16:00:00Z
EndTime	string	O fim do intervalo de tempo durante o qual os dados foram consultados. Especifique o horário no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2023-04-19T15:59:59Z

Exemplos

Resposta de sucesso

JSON formato

{
  "UrlDetailData": [
    {
      "Url": "example.com/test",
      "ClientPlatform": "PC",
      "Country": "CN",
      "TTFB": 123,
      "FCP": 123,
      "LCP": 123,
      "CLS": 0.5,
      "FID": 123,
      "INP": 123
    }
  ],
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "StartTime": "2022-11-06T16:00:00Z",
  "EndTime": "2023-04-19T15:59:59Z"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.TimeRange	The specified time range exceeds the limit. Adjust it and try again.	The specified time range exceeds the limit. Adjust it and try again.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.
400	InvalidParameter	Parameter verification failed. Check your configurations and try again.	Parameter verification failed. Check your configurations and try again.
400	InvalidTime.Malformed	Specified start time or end time is malformed.	The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.