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

Consulta os registros mais bem classificados em um relatório de análise de tráfego por site ou conta da Alibaba Cloud.

Descrição da operação

Se você não especificar StartTime e EndTime, os dados das últimas 24 horas serão retornados. Se você especificar StartTime e EndTime, os dados do intervalo de tempo especificado serão retornados.\n\n- Devido ao grande número de visitas durante o intervalo de tempo consultado, os resultados da análise de dados podem ser amostrados.

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:DescribeSiteTopData

none

*Site

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	string	Não	O ID do site, que pode ser obtido chamando a operação ListSites.\n\nSe você não especificar este parâmetro, o sistema retornará os dados por conta.	1150376036*****
StartTime	string	Não	O início do intervalo de tempo a ser consultado.\n\nEspecifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.	2023-04-08T16:00:00Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado.\n\nEspecifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.\n\n> A hora de fim deve ser posterior à hora de início.	2023-04-09T16:00:00Z
Interval	string	Não	O intervalo de tempo entre as entradas de dados a serem retornadas. Unidade: segundos.	300
Fields	array<object>	Sim	As métricas a serem consultadas.
	object	Não	A métrica a ser consultada.
FieldName	string	Não	O nome da métrica.	Traffic
Dimension	array	Não	As dimensões nas quais você deseja consultar os dados.
	string	Não	A dimensão na qual você deseja consultar os dados.\n\n> Para mais informações, consulte os campos de log correspondentes.	ALL
Limit	string	Não	O número de entradas de dados mais bem classificadas a serem consultadas. Valores válidos: 5 : 5 10 : 10 150 : 150	5

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Data	array<object>	Os dados retornados.
	array<object>	Os dados retornados.
FieldName	string	O nome da métrica.	Traffic
DimensionName	string	A dimensão na qual os dados foram consultados.	ALL
DetailData	array<object>	Os dados retornados.
	object	Os dados retornados.
DimensionValue	string	The dimension value.	ALL
Value	any	The queried numeric value.	123
RequestId	string	O ID da solicitação.	35C66C7B-671H-4297-9187-2C447724****
StartTime	string	O início do intervalo de tempo durante o qual os dados foram consultados.\n\nA hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2023-04-08T16:00:00Z
EndTime	string	O fim do intervalo de tempo durante o qual os dados foram consultados.\n\nA hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2023-04-09T16:00:00Z
SamplingRate	number	A taxa de amostragem.	100

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": [
    {
      "FieldName": "Traffic",
      "DimensionName": "ALL",
      "DetailData": [
        {
          "DimensionValue": "ALL",
          "Value": "123"
        }
      ]
    }
  ],
  "RequestId": "35C66C7B-671H-4297-9187-2C447724****",
  "StartTime": "2023-04-08T16:00:00Z",
  "EndTime": "2023-04-09T16:00:00Z",
  "SamplingRate": 100
}

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	QuotaCheckFailed.Function	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.
400	InvalidParameter.Field	The specified Field is invalid.	The specified Field is invalid. For more information, see OpenAPI Documentation .
400	InvalidParameter.Dimension	The specified Dimension is invalid.	The specified Dimension is invalid. For more information, see OpenAPI Documentation .
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.
400	TooManyDimensions	Too many query dimensions specified. Delete some and try again.	Too many query dimensions specified. Delete some 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.