DescribeNetworkFlowTopNMetric - Web Application Firewall: Central de Documentação do Alibaba Cloud

Consulta as estatísticas Top N de todo o tráfego que passa pelo Web Application Firewall (WAF), incluindo solicitações de serviço maliciosas e normais. Os resultados são agregados por diferentes dimensões e classificados em ordem decrescente.

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

yundun-waf:DescribeNetworkFlowTopNMetric

get

*All Resource

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância do WAF. Nota Você pode chamar a operação DescribeInstance para consultar o ID da instância do WAF.	waf_cdnsdf3****
Filter	object	Sim	As condições de filtro para a consulta. Se você especificar várias condições de filtro, todas as condições deverão ser atendidas (E lógico).
DateRange	object	Sim	O intervalo de tempo a ser consultado.
StartDate	integer	Sim	O início do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX. Unidade: segundos. O intervalo de tempo não pode exceder os últimos 30 dias. Nota A hora de início deve ser posterior a 30 dias antes da hora atual.	1713888000
EndDate	integer	Sim	O fim do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX. Unidade: segundos.	1713888600
Conditions	array<object>	Não	A lista de condições de filtro.
	object	Não	Uma única condição de filtro. Uma condição de filtro consiste em um nome de campo (Key), um operador (OpValue) e um valor de filtro (Values). Para obter mais informações sobre os nomes de campo e operadores compatíveis, consulte a seção Informações adicionais sobre os parâmetros da solicitação.
Key	string	Não	O nome do campo a ser usado para filtragem. Valores válidos: matched_host cluster	matched_host
OpValue	string	Não	O operador usado para a condição de filtro. Para obter mais informações sobre os operadores compatíveis, consulte a seção Informações adicionais sobre os parâmetros da solicitação.	eq
Values	any	Não	O valor a ser usado para a condição de filtro. O formato do valor depende da Key e do OpValue que você especificar.	test.waf-top
Limit	integer	Sim	O número máximo de entradas a serem retornadas. Os resultados são classificados em ordem decrescente. Valor máximo: 10.	10
Metric	string	Sim	A métrica pela qual consultar e classificar os dados. Valores válidos: real_client_ip: Retorna os N principais endereços IP de origem das solicitações enviadas ao WAF. Os dados são agregados por endereço IP de origem e classificados em ordem decrescente. http_user_agent: Retorna os N principais user agents das solicitações enviadas ao WAF. Os dados são agregados por user agent e classificados em ordem decrescente. request_path: Retorna as N principais URLs de solicitação. Os dados são agregados por URL e classificados em ordem decrescente. matched_host_by_total_requests: Retorna os N principais objetos protegidos pelo número total de solicitações recebidas. matched_host_by_qps: Retorna os N principais objetos protegidos por consultas por segundo (QPS). matched_host_by_status: Retorna os N principais objetos protegidos com base em um código de status HTTP específico retornado pelo WAF. Os dados são agregados por objeto protegido e classificados em ordem decrescente. Se você definir Metric com este valor, deverá especificar o campo status no parâmetro Conditions de Filter. O formato é o seguinte: {"Key":"status","OpValue":"eq","Values":"200"} matched_host_by_upstream_status: Retorna os N principais objetos protegidos com base em um código de status HTTP específico retornado pelo servidor de origem. Os dados são agregados por objeto protegido e classificados em ordem decrescente. Se você definir Metric com este valor, deverá especificar o campo upstream_status no parâmetro Conditions de Filter. O formato é o seguinte: {"Key":"upstream_status","OpValue":"eq","Values":"200"}	matched_host_by_upstream_status
RegionId	string	Não	A região na qual a instância do WAF reside. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fora da China continental.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q

Descrição dos operadores

Operador	Significado	Descrição
all-not-match	Não é igual a nenhum dos valores	O valor do campo não é igual a nenhum dos valores especificados. Por exemplo, para excluir solicitações de endereços IP de origem específicos: `{"Key":"real_client_ip","OpValue":"all-not-match","Values":["1.XX.XX.1","2.XX.XX.2","3.XX.XX.3"]}`
eq	Igual a	O valor do campo é igual à string especificada. Por exemplo, para consultar estatísticas de solicitações com o caminho de URL "/testcase": `{"Key":"request_path","OpValue":"eq","Values":"/testcase"}`
match-one	Igual a um dos valores	O valor do campo é igual a um dos valores especificados. Por exemplo, para consultar estatísticas de solicitações de endereços IP de origem específicos: `{"Key":"real_client_ip","OpValue":"match-one","Values":["1.XX.XX.1","2.XX.XX.2","3.XX.XX.3"]}`
ne	Não é igual a	O valor do campo não é igual à string especificada. Por exemplo, para excluir solicitações com o caminho de URL "/testcase": `{"Key":"request_path","OpValue":"ne","Values":"/testcase"}`

Chaves compatíveis para condições de filtro

Nome do campo	Descrição do campo	Operadores compatíveis
cluster	O cluster de proteção.	ne, eq, match-one, all-not-match
matched_host	O objeto protegido.	ne, eq, match-one, all-not-match

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta. Para obter mais informações sobre o formato, consulte a seção Exemplos.
RequestId	string	O ID da solicitação.	D827FCFE-90A7-4330-9326-******4C7726
NetworkFlowTopNValues	array<object>	Um array das estatísticas Top N.
	object	Uma única entrada nos resultados da classificação Top N.
Name	string	O valor da dimensão que corresponde ao parâmetro de solicitação Metric especificado. Por exemplo, se Metric estiver definido como real_client_ip, este parâmetro indicará o endereço IP de origem.	127.0.0.1
Attribute	string	O atributo adicional associado à entrada. Por exemplo, quando Metric está definido como real_client_ip, este parâmetro indica o país ou a região à qual o endereço IP pertence.	CN
Value	integer	O número total de solicitações ou o valor de QPS, dependendo da Metric especificada. Este valor é usado para a classificação Top N.	1123
TopNMetaData	object	Os metadados dos dados retornados.
DateRange	object	O intervalo de tempo usado para a consulta.
StartDate	integer	The beginning of the time range. This value is a UNIX timestamp. Unit: seconds.	1713888000
EndDate	integer	The end of the time range. This value is a UNIX timestamp. Unit: seconds.	1713888600
Units	string	A unidade dos dados estatísticos retornados.	requests

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D827FCFE-90A7-4330-9326-******4C7726",
  "NetworkFlowTopNValues": [
    {
      "Name": "127.0.0.1",
      "Attribute": " CN",
      "Value": 1123
    }
  ],
  "TopNMetaData": {
    "DateRange": {
      "StartDate": 1713888000,
      "EndDate": 1713888600
    },
    "Units": "requests\n"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Waf.Report.%s	Invalid parameter:%s.	Invalid parameter:%s
400	Waf.Report.InternalError	Server error occurred in report service.	Report Service Internal Error

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.