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

Consulta as estatísticas de séries temporais de todo o tráfego, incluindo solicitações maliciosas e solicitações normais de serviç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

yundun-waf:DescribeNetworkFlowTimeSeriesMetric

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 Chame DescribeInstance para obter o ID da instância.	waf_cdnsdf3****
Filter	object	Sim	As condições de filtro para a consulta. Várias condições de filtro têm uma relação lógica AND.
DateRange	object	Sim	O intervalo de tempo a ser consultado.
StartDate	integer	Sim	O início do intervalo de tempo a ser consultado, no formato de timestamp UNIX. Unidade: segundos. O intervalo de tempo da consulta não pode exceder os últimos 30 dias. Nota A hora de início deve estar dentro dos últimos 30 dias.	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	Uma lista de condições de filtro. Cada item descreve uma condição de filtro.
	object	Não	A configuração de uma única condição de filtro. Uma condição de filtro consiste em um nome de campo, um operador e um valor de filtro. Para obter mais informações sobre os nomes de campo e operadores suportados, consulte Informações adicionais sobre os parâmetros de solicitação.
Key	string	Não	O campo a ser usado para filtragem. Este parâmetro suporta os seguintes campos: matched_host: O objeto protegido. cluster: O cluster de proteção.	matched_host
OpValue	string	Não	O operador.	eq
Values	any	Não	O valor do filtro.	test.waf-top
Metric	string	Sim	A métrica a ser consultada. Métricas diferentes retornam dados diferentes. Valores válidos: qps: O número de solicitações que o WAF processa por segundo. Este é um valor de pico. O WAF calcula um valor de consultas por segundo (QPS) a cada 10 segundos e usa o valor de pico dentro da granularidade de tempo especificada como o QPS. total_requests: O número total de solicitações que o WAF processa. top5_status: Os cinco principais códigos de resposta que o WAF retorna ao cliente e as estatísticas de séries temporais correspondentes. top5_upstream_status: Os cinco principais códigos de resposta que o servidor de origem retorna ao cliente e as estatísticas de séries temporais correspondentes.	total_requests
RegionId	string	Não	A região da instância do WAF. 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ções 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 valor na coleção. Por exemplo, para filtrar solicitações onde real_client_ip não é igual a nenhum valor na coleção: `{"Key":"real_client_ip","OpValue":"all-not-match","Values":["1.1.1.1","2.2.2.2","3.3.3.3"]}`
eq	Igual a	O valor do campo é igual a uma string. Por exemplo, para filtrar estatísticas de solicitações onde a URL é igual a "/testcase": `{"Key":"request_path","OpValue":"eq","Values":"/testcase"}`
match-one	Igual a um dos valores	O valor do campo é igual a qualquer valor na coleção. Por exemplo, para filtrar solicitações onde real_client_ip é igual a qualquer valor na coleção: `{"Key":"real_client_ip","OpValue":"match-one","Values":["1.1.1.1","2.2.2.2","3.3.3.3"]}`
ne	Não igual a	O valor do campo não é igual a uma string. Por exemplo, para filtrar estatísticas de solicitações onde a URL não é igual a "/testcase": `{"Key":"request_path","OpValue":"ne","Values":"/testcase"}`

Chaves suportadas para condições de filtro

Nome do campo	Descrição	Operadores suportados
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	Os dados retornados. Para um formato de exemplo, consulte a seção Exemplos.
RequestId	string	O ID da solicitação.	D827FCFE-90A7-4330-9326-D33C8B4*****
NetworkFlowTimeSeries	array<object>	Os dados de séries temporais. Várias séries de dados podem ser retornadas.
	object	Uma única série temporal. Os dados de séries temporais consistem em dois arrays: Timestamps e Values. O array Timestamps contém uma sequência de timestamps em intervalos fixos. O array Values contém a contagem estatística para cada intervalo. Os dois arrays têm o mesmo número de pontos de dados, e os pontos de dados correspondem uns aos outros.
Metric	string	O nome da métrica. Este valor é o mesmo que o parâmetro de solicitação Metric.	total_requests
Timestamps	array	Os timestamps. Cada valor representa o início de um intervalo de tempo.
	string	A hora de início de cada ponto de dados. Este valor é uma string de timestamp UNIX.	[]
Values	array	Os valores da métrica. Cada valor representa a contagem dentro do intervalo de tempo correspondente.
	integer	A contagem estatística para o intervalo de tempo atual.	[]
TimeSeriesMetaData	object	Os metadados dos dados retornados.
DateRange	object	O intervalo de tempo que foi consultado.
StartDate	integer	The start of the time range that was queried. This value is a UNIX timestamp. Unit: seconds. This value is the same as the StartDate request parameter.	1713888000
EndDate	integer	The end of the time range that was queried. This value is a UNIX timestamp. Unit: seconds. This value is the same as the EndDate request parameter.	1713888600
AggregateInterval	string	A granularidade de tempo de cada ponto de dados na série temporal retornada. Por exemplo, "15m" indica que cada ponto de dados representa estatísticas para um intervalo de 15 minutos. Para obter mais informações sobre a granularidade de tempo, consulte a seção Granularidade de tempo dos pontos de dados.	1m
Units	string	A unidade dos dados retornados. Valor padrão: solicitações.	requests

Granularidade de tempo dos pontos de dados

A granularidade de tempo dos dados retornados varia com base no intervalo de tempo especificado.

Se o intervalo de tempo for menor que 3 horas, a granularidade de tempo é de 1m (1 minuto).
Se o intervalo de tempo for de 3 horas ou mais e menor que 6 horas, a granularidade de tempo é de 5m (5 minutos).
Se o intervalo de tempo for de 6 horas ou mais e menor que 24 horas, a granularidade de tempo é de 15m (15 minutos).
Se o intervalo de tempo for de 24 horas ou mais e menor que 7 dias, a granularidade de tempo é de 1h (1 hora).
Se o intervalo de tempo for de 7 dias ou mais e menor que 30 dias, a granularidade de tempo é de 1d (1 dia).

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4*****",
  "NetworkFlowTimeSeries": [
    {
      "Metric": "total_requests",
      "Timestamps": [
        "[]"
      ],
      "Values": [
        0
      ]
    }
  ],
  "TimeSeriesMetaData": {
    "DateRange": {
      "StartDate": 1713888000,
      "EndDate": 1713888600
    },
    "AggregateInterval": "1m",
    "Units": "requests"
  }
}

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.