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

Consulta os dados de série temporal do tráfego de ataque. Solicitações de ataque são solicitações que acionaram uma regra e foram identificadas como uma ameaça.

Descrição da operação

Tráfego de ataque refere-se a solicitações que acionaram uma regra e foram identificadas como uma ameaça. Os seguintes dados são excluídos:

Solicitações que acionaram uma regra de whitelist.
Solicitações que acionaram uma regra de bot em que a ação da regra é "Mark for origin fetch".
Solicitações que acionaram uma regra com a ação "Dynamic Token", "Slider", "Strict Slider" ou "JS Challenge", mas foram permitidas porque o usuário passou na verificaçã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:DescribeSecurityEventTimeSeriesMetric

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 Web Application Firewall (WAF). Nota Chame DescribeInstance para consultar o ID da instância do WAF.	waf-cn-tl32ast****
Filter	object	Sim	As condições de filtro para a consulta. Múltiplas condições de filtro possuem uma relação lógica AND.
DateRange	object	Sim	O intervalo de tempo a ser consultado.
StartDate	integer	Sim	Você pode consultar dados dos últimos 30 dias. O horário de início da consulta. Este é um timestamp UNIX. Unidade: segundos. Nota O horário de início deve estar dentro dos últimos 30 dias.	1713888000
EndDate	integer	Sim	O horário de término da consulta. Este é um timestamp UNIX. Unidade: segundos.	1713888600
Conditions	array<object>	Não	Uma lista de condições de filtro. Cada nó descreve uma condição de filtro.
	object	Não	Uma única condição de consulta, que consiste em um nome de campo, um operador e um valor de filtro. Para informações sobre os nomes de campos e operadores suportados, consulte Informações adicionais sobre parâmetros de solicitação.
Key	string	Não	O nome do campo a ser filtrado. Esta operação suporta todos os campos.	matched_host
OpValue	string	Não	O operador.	eq
Values	any	Não	O valor do filtro.	test.waf-top
Metric	string	Sim	Especifica o conteúdo dos dados retornados. Diferentes métricas correspondem a diferentes conteúdos de dados. Esta operação suporta as seguintes métricas: mitigated_requests: Retorna as estatísticas de série temporal de solicitações bloqueadas. monitored_requests: Retorna as estatísticas de série temporal de solicitações que acionaram apenas regras do tipo observação. mitigated_requests_group_by_defense_scene: Retorna dados agrupados por módulo. Registra um gráfico de série temporal da contagem de acionamentos para cada módulo. Uma única solicitação pode acionar múltiplos módulos. Portanto, a contagem de acionamentos retornada por esta métrica pode não ser consistente com o número de solicitações. mitigated_requests_group_by_block_defense_scene: Retorna dados agrupados por módulo. Registra um gráfico de série temporal do número de solicitações bloqueadas para cada módulo. Uma única solicitação é bloqueada por apenas um módulo. Portanto, a contagem retornada por esta métrica é consistente com o número de solicitações.	mitigated_requests
RegionId	string	Não	A região onde 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ções dos operadores

Operador	Significado	Descrição
all-not-match	Não é igual a nenhum valor	O valor do campo não é igual a nenhum valor no conjunto de dados. 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"]}`
contain	Contém	O valor do campo contém uma string específica. Por exemplo, para filtrar dados onde a URL contém "test": `{"Key":"request_path","OpValue":"contain","Values":"test"}`
eq	Igual a	O valor do campo é igual a uma string específica. Por exemplo, para filtrar dados onde a URL é igual a "/testcase": `{"Key":"request_path","OpValue":"eq","Values":"/testcase"}`
match-one	Igual a um de múltiplos valores	O valor do campo é igual a qualquer valor no conjunto de dados. 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	Diferente de	O valor do campo não é igual a uma string específica. Por exemplo, para filtrar estatísticas onde a URL não é igual a "/testcase": `{"Key":"request_path","OpValue":"ne","Values":"/testcase"}`
not-contain	Não contém	O valor do campo não contém uma string específica. Por exemplo, para filtrar dados onde a URL não contém "test": `{"Key":"request_path","OpValue":"not-contain","Values":"test"}`
prefix-match	Correspondência de prefixo	O valor do campo começa com uma string específica. Por exemplo, para filtrar dados onde o prefixo da URL é "/testcase": `{"Key":"request_path","OpValue":"prefix-match","Values":"/testcase"}`
suffix-match	Correspondência de sufixo	O valor do campo termina com uma string específica. Por exemplo, para filtrar dados onde o sufixo da URL é "/testcase": `{"Key":"request_path","OpValue":"suffix-match","Values":"/testcase"}`

Chaves suportadas para condições de filtro

Nome do campo	Descrição	Operadores suportados
action	A ação de proteção. Esta é a ação final tomada sobre a solicitação.	ne, eq
cluster	O cluster de proteção.	ne, eq, match-one, all-not-match
defense_scene	O módulo de proteção. Uma solicitação pode acionar múltiplos módulos de proteção. Solicitações filtradas por este campo também podem acionar outros módulos.	ne, eq
host	O host do cabeçalho HTTP.	contain, not-contain, ne, eq, match-one, all-not-match, prefix-match, suffix-match
http_cookie	O cookie do cabeçalho HTTP.	contain, not-contain, ne, eq, match-one, all-not-match, prefix-match, suffix-match
http_user_agent	O User-Agent do cabeçalho HTTP.	contain, not-contain, ne, eq, match-one, all-not-match, prefix-match, suffix-match
matched_host	O objeto protegido.	ne, eq, match-one, all-not-match
real_client_ip	O endereço IP de origem da solicitação. O parâmetro que segue o operador deve ser uma string de endereço IP ou uma lista de strings de endereço IP. Consultas por bloco CIDR não são suportadas.	ne, eq, match-one, all-not-match
remote_country_id	O país ao qual o endereço IP de origem da solicitação HTTP pertence.	ne, eq, match-one, all-not-match
remote_region_id	A província ou cidade à qual o endereço IP de origem da solicitação HTTP pertence.	ne, eq, match-one, all-not-match
request_method	O método de solicitação HTTP.	ne, eq, match-one, all-not-match
request_path	A URL da solicitação HTTP, excluindo a query string.	contain, not-contain, ne, eq, match-one, all-not-match, prefix-match, suffix-match
request_traceid	O ID único que identifica a solicitação.	ne, eq, match-one, all-not-match
rule_id	O ID da regra. Uma solicitação pode acionar múltiplas regras. Solicitações filtradas por este campo também podem acionar outras regras.	ne, eq

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-*****4C7726
SecurityEventTimeSeries	array<object>	Os dados de série temporal retornados. A operação pode retornar dados de série temporal para múltiplos valores.
	object	Um único conjunto de dados de série temporal. Os dados de série temporal consistem em dois arrays: Timestamps e Values. O array Timestamps contém uma série temporal com intervalos fixos. O array Values contém a contagem estatística para cada intervalo. Os dois arrays possuem o mesmo número de nós, e seus pontos de dados possuem uma correspondência um-para-um.
Metric	string	O conteúdo dos dados retornados. Isto é consistente com o parâmetro de solicitação Metric.	monitored_requests
Timestamps	array	A série temporal. Cada ponto representa o horário de início de um intervalo de tempo.
	string	O horário de início para cada ponto de dados. Este é uma string de timestamp UNIX.	[]
Values	array	A série de dados. Cada ponto representa a contagem estatística dentro de um intervalo de tempo específico.
	integer	A contagem estatística para o intervalo de tempo atual.	[]
TimeSeriesMetaData	object	Os metadados dos dados retornados.
DateRange	object	O intervalo de tempo utilizado para a consulta.
StartDate	integer	The start time of the query. This is a UNIX timestamp. Unit: seconds. This value is the same as the `StartDate` request parameter.	1713888000
EndDate	integer	The end time of the query. This is a UNIX timestamp. Unit: seconds. This value is the same as the `EndDate` request parameter.	1713888600
AggregateInterval	string	A granularidade temporal de cada ponto de dados nos dados de série temporal retornados. Por exemplo, "15m" indica que cada ponto de dados retornado representa estatísticas para um intervalo de 15 minutos. Para mais informações sobre a granularidade temporal dos dados retornados, consulte a seção Granularidade temporal dos pontos de dados de série temporal.	1m
Units	string	A unidade dos dados estatísticos retornados.	requests

Granularidade temporal dos pontos de dados de série temporal

A granularidade temporal estatística dos dados retornados varia com base no intervalo de tempo selecionado.

Se o intervalo de tempo for inferior a 3 horas, a granularidade temporal dos pontos de dados é 1m (1 minuto).
Se o intervalo de tempo for de 3 horas ou mais, mas inferior a 6 horas, a granularidade temporal dos pontos de dados é 5m (5 minutos).
Se o intervalo de tempo for de 6 horas ou mais, mas inferior a 24 horas, a granularidade temporal dos pontos de dados é 15m (15 minutos).
Se o intervalo de tempo for de 24 horas ou mais, mas inferior a 7 dias, a granularidade temporal dos pontos de dados é 1h (1 hora).
Se o intervalo de tempo for de 7 dias ou mais, mas inferior a 30 dias, a granularidade temporal dos pontos de dados é 1d (1 dia).

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D827FCFE-90A7-4330-9326-*****4C7726\n",
  "SecurityEventTimeSeries": [
    {
      "Metric": "monitored_requests",
      "Timestamps": [
        "[]"
      ],
      "Values": [
        0
      ]
    }
  ],
  "TimeSeriesMetaData": {
    "DateRange": {
      "StartDate": 1713888000,
      "EndDate": 1713888600
    },
    "AggregateInterval": "1m",
    "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.