Consulta uma lista paginada de regras de proteçã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:DescribeDefenseRules

list

*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 a operação DescribeInstance para consultar o ID da instância do WAF.	waf_cdnsdf3****
RuleType	string	Não	O tipo da regra de proteção. Valores válidos: whitelist: uma regra de lista de permissões defense (padrão): uma regra de proteção Nota Este parâmetro é obrigatório apenas quando DefenseType está definido como template.	whitelist
Query	string	Não	As condições de consulta. Especifique este parâmetro como uma string JSON. Nota Os resultados da consulta para regras de proteção variam com base nas condições de consulta. Para mais informações, consulte Detalhes do parâmetro de consulta.	{\"name\":\"IPblock_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327}
PageNumber	integer	Não	O número da página a ser retornada. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10.	10
DefenseType	string	Não	O tipo da regra de proteção. Valores válidos: template (padrão): regras de proteção de modelo. resource: regras para objetos protegidos. global: regras globais. Valores válidos: template : template. resource : resource. global : global.	template
RegionId	string	Não	A região onde a instância do WAF reside. Valores válidos: cn-hangzhou: a parte continental da China. ap-southeast-1: fora da parte continental da China.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q

Detalhes do parâmetro de consulta.

Regras de proteção de modelo (template)

Se você definir DefenseType como template, os seguintes parâmetros estarão disponíveis.

Descrições dos parâmetros

Nome	Tipo	Obrigatório	Exemplo	Descrição
name	String	Não	test	O nome da regra de proteção a ser consultada. Você pode definir este parâmetro para realizar uma consulta de termo para uma regra de proteção.
nameId	String	Não	test1	O ID ou nome da regra de proteção a ser consultada. Você pode definir este parâmetro para realizar uma consulta difusa para uma regra de proteção.
nameLike	String	Não	test.aliyundoc.c	O nome da regra de proteção a ser consultada. Você pode definir este parâmetro para realizar uma consulta difusa para uma regra de proteção.
scene	String	Não	waf_group	O cenário de proteção que você deseja consultar. Você pode definir este parâmetro para realizar uma consulta de termo para as regras de proteção em um cenário específico. Valores válidos: - waf_group: regras de expressão regular para proteção básica. - waf_base: regras para o novo recurso de proteção central da web. - waf_base_compliance: regras de conformidade de protocolo para proteção básica. - waf_base_sema: regras semânticas para proteção básica. - cc: proteção contra HTTP flood. - antiscan_dirscan: bloqueio de travessia de diretório para proteção contra varredura. - antiscan_highfreq: bloqueio de varredura de alta frequência para proteção contra varredura. - antiscan_scantools: bloqueio de scanner para proteção contra varredura. - ip_blacklist: lista de negação de endereços IP. - custom_acl: regras personalizadas. - region_block: bloqueio geográfico. - tamperproof: proteção contra adulteração de página da web. - dlp: prevenção contra vazamento de dados. - custom_response_block: resposta personalizada.
ruleId	Long	Não	33444	O ID da regra de proteção a ser consultada. Você pode definir este parâmetro para realizar uma consulta de termo para uma regra de proteção.
ruleIdIn	Array	Não	[3334455643,345555]	O intervalo de IDs de regras de proteção a serem consultados. Você pode definir este parâmetro para consultar várias regras de proteção. Separe vários IDs de regras com vírgulas (,).
templateId	Long	Não	24354	O ID do modelo de proteção a ser consultado. Você pode definir este parâmetro para consultar as regras de proteção em um modelo de proteção.
orderBy	String	Não	name	O método de classificação para regras de proteção. Valores válidos: - name: classifica as regras por nome. - gmtModified: classifica as regras por hora de modificação. - id: classifica as regras por ID. - templateId: classifica as regras por ID do modelo.
desc	Boolean	Não	true	A ordem de classificação. Valores válidos: - false: ordem crescente. - true: ordem decrescente.

Exemplo

{
    "name": "test",
    "nameId ": "test1,
    "nameLike": "test.aliyundoc.c",
    "nameIn": "test.aliyundoc.c",
    "InstaneId": "test1.aliyundoc.com,test2.aliyundoc.com",
    "templateId": 24354
}

Regras para objetos protegidos (resource)

Se você definir DefenseType como resource, os seguintes parâmetros estarão disponíveis.

Descrições dos parâmetros

Nome	Tipo	Obrigatório	Exemplo	Descrição
resource	String	Não	sec****-waf	O objeto protegido ao qual a regra é aplicada.
scene	String	Não	waf_group	O cenário de proteção que você deseja consultar. Você pode definir este parâmetro para realizar uma consulta de termo para as regras de proteção em um cenário específico. Valores válidos: - account_identifier: regras de busca de conta. - custom_response: nova resposta personalizada.

Exemplo

{
    "resource": "sec****-waf",
    "scene ": "account_identifier"
}

Regras globais (global)

Se você definir DefenseType como global, os seguintes parâmetros estarão disponíveis.

Descrições dos parâmetros

Nome	Tipo	Obrigatório	Exemplo	Descrição
scene	String	Não	regular_custom	O cenário de proteção que você deseja consultar. Você pode definir este parâmetro para realizar uma consulta de termo para as regras de proteção em um cenário específico. Valores válidos: - regular_custom: regras de expressão regular personalizadas. - custom_response: nova resposta personalizada.
detectType	String	Não	sqli	O módulo de detecção a ser consultado. Valores válidos: - sqli: injeção de SQL. - xss: cross-site scripting (XSS). - cmdi: injeção de comando do sistema operacional. - expression_injection: injeção de expressão. - java_deserialization: desserialização Java. - dot_net_deserialization: desserialização .NET. - php_deserialization: desserialização PHP. - code_exec: execução de código. - ssrf: server-side request forgery (SSRF). - path_traversal: travessia de caminho. - arbitrary_file_uploading: upload arbitrário de arquivo. - webshell: webshell. - rfilei: remote file inclusion (RFI). - lfilei: local file inclusion (LFI). - protocol_violation: violação de protocolo. - scanner_behavior: comportamento de scanner. - logic_flaw: falha de lógica de negócios. - arbitrary_file_reading: leitura arbitrária de arquivo. - arbitrary_file_download: download arbitrário de arquivo. - xxe: injeção de entidade externa. - csrf: cross-site request forgery. - crlf: CRLF. - other: outro. Importante Este parâmetro é suportado apenas quando scene está definido como regular_custom.
riskLevel	String	Não	strict	O nível de ameaça a ser consultado. Valores válidos: - super_strict: Super Rigoroso. - strict: Rigoroso. - medium: Médio. - loose: Flexível. Importante Este parâmetro é suportado apenas quando scene está definido como regular_custom.
templateId	Long	Não	24354	O ID do modelo de proteção a ser consultado. Você pode definir este parâmetro para consultar as regras de proteção em um modelo de proteção. Importante Este parâmetro é suportado apenas quando scene está definido como regular_custom.

Exemplo

{
    "detectType": "sqli",
    "riskLevel ": "strict",
    "templateId": 24354
}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
TotalCount	integer	O número total de entradas retornadas.	2
RequestId	string	O ID da solicitação.	80736FA5-FA87-55F6-AA69-C5477C6FE6D0
Rules	array<object>	A lista de regras de proteção.
	object	A regra de proteção.
Status	integer	O status da regra de proteção. Valores válidos: 0: desativada. 1: ativada.	1
DefenseOrigin	string	A origem da regra de proteção. Valores válidos: custom: A regra é criada pelo usuário. system: A regra é gerada automaticamente pelo sistema.	custom
Config	string	Os detalhes da regra de proteção. O valor é uma string JSON. Para mais informações, consulte a descrição do parâmetro Rule em CreateDefenseRule.	{\"policyId\":1012,\"action\":\"block\"}
RuleId	integer	O ID da regra de proteção.	42755
DefenseScene	string	O cenário de proteção. Se o parâmetro de solicitação DefenseType estiver definido como template, os valores válidos são: waf_group: regras de expressão regular para proteção básica. waf_base: regras para o novo recurso de proteção central da web. waf_base_compliance: regras de conformidade de protocolo para proteção básica. waf_base_sema: regras semânticas para proteção básica. cc: proteção contra HTTP flood. antiscan_dirscan: bloqueio de travessia de diretório para proteção contra varredura. antiscan_highfreq: bloqueio de varredura de alta frequência para proteção contra varredura. antiscan_scantools: bloqueio de scanner para proteção contra varredura. ip_blacklist: lista de negação de endereços IP. custom_acl: regras personalizadas. region_block: bloqueio geográfico. tamperproof: proteção contra adulteração de página da web. dlp: prevenção contra vazamento de dados. custom_response_block: resposta personalizada. spike_throttle: limitação de tráfego de pico. Se o parâmetro de solicitação DefenseType estiver definido como resource, os valores válidos são: account_identifier: busca de conta. custom_response: nova resposta personalizada. waf_codec: decodificação. Se o parâmetro de solicitação DefenseType estiver definido como global, os valores válidos são: regular_custom: expressão regular personalizada. address_book: livro de endereços. custom_response: nova resposta personalizada.	waf_group
GmtModified	integer	A hora em que a regra de proteção foi modificada pela última vez. Este valor é um carimbo de data/hora UNIX. Unidade: milissegundos.	1665460629000
RuleName	string	O nome da regra de proteção.	rules_41
TemplateId	integer	O ID do modelo de proteção.	5673
GmtCreate	integer	A hora em que a regra de proteção foi criada. Este valor é um carimbo de data/hora UNIX. Unidade: milissegundos.	1665460629000
Resource	string	O objeto protegido ao qual a regra é aplicada. Nota Este parâmetro é retornado apenas quando o parâmetro de solicitação DefenseType está definido como resource.	rencs***-waf
DefenseType	string	O tipo da regra de proteção. Valores válidos: template (padrão): regras de proteção de modelo. resource: regras para objetos protegidos. global: regras globais.	template
Description `deprecated`	string	Este parâmetro foi descontinuado.	rule description
RuleType `deprecated`	string	Este parâmetro foi descontinuado.	custom_cc
ActionExternal `deprecated`	string	Este parâmetro foi descontinuado.	42755
DetailRuleIds `deprecated`	string	Este parâmetro foi descontinuado.	42755
ExternalInfo `deprecated`	string	Este parâmetro foi descontinuado.	{\"DetectType\":\"sqli\"}

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 2,
  "RequestId": "80736FA5-FA87-55F6-AA69-C5477C6FE6D0",
  "Rules": [
    {
      "Status": 1,
      "DefenseOrigin": "custom",
      "Config": "{\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
      "RuleId": 42755,
      "DefenseScene": "waf_group",
      "GmtModified": 1665460629000,
      "RuleName": "rules_41",
      "TemplateId": 5673,
      "GmtCreate": 1665460629000,
      "Resource": "rencs***-waf",
      "DefenseType": "template",
      "Description": "rule description",
      "RuleType": "custom_cc",
      "ActionExternal": "42755",
      "DetailRuleIds": "42755",
      "ExternalInfo": "{\\\"DetectType\\\":\\\"sqli\\\"}"
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.