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

Consulta as políticas de mitigação do Web Application Firewall (WAF) configuradas.

Descrição da operação

Nota

Um único usuário pode fazer até 20 chamadas por segundo.

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

dcdn:DescribeDcdnWafPolicies

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
QueryArgs	string	Não	A consulta condicional, que é uma string serializada em JSON. O formato é o seguinte: `QueryArgs={"PolicyIds":"ID da política de mitigação","RuleIds":"intervalo de IDs de regras de mitigação","PolicyNameLike":"nome da política de mitigação","DomainNames":"nome do domínio protegido","PolicyType":"default","DefenseScenes":"waf_group","PolicyStatus":"on","OrderBy":"GmtModified","Desc":"false"}`\n\n> Se este parâmetro não for especificado, todas as políticas de mitigação serão consultadas.	{"PolicyNameLIike":"test_policy"}
PageNumber	integer	Não	O número da página. Valor padrão: 1. Valores válidos: 1 a 100000.	1
PageSize	integer	Não	O número de políticas de mitigação a serem retornadas em cada página. Valor padrão: 20. Valores válidos: um número inteiro de 1 a 500.	20

Parâmetros de QueryArgs

Nome	Tipo	Obrigatório	Exemplo	Descrição
PolicyIds	string	Não	10000001,10000002	A lista de IDs de políticas de mitigação. Esta é uma consulta de termo. Separe vários IDs com uma vírgula (,).
RuleIds	string	Não	20000001,20000055	A lista de IDs de regras. Esta é uma consulta de termo. Separe vários IDs com uma vírgula (,).
PolicyNameLike	string	Não	policy_test	O nome da política de mitigação. Esta é uma consulta difusa. O nome pode conter caracteres chineses, letras (sensíveis a maiúsculas e minúsculas), dígitos (0 a 9) e sublinhados (_).
DomainNames	string	Não	example.com	A lista de nomes de domínio protegidos. Esta é uma consulta de termo. Você pode especificar até 50 nomes de domínio. Separe vários nomes de domínio com uma vírgula (,).
PolicyType	string	Não	default	Especifica se a política é uma política de mitigação padrão. Valores válidos: `default`: uma política de mitigação padrão. `custom`: uma política de mitigação personalizada.
DefenseScenes	string	Não	custom_acl	O cenário de mitigação. Esta é uma consulta de termo. Separe vários cenários com uma vírgula (,). Os seguintes cenários são suportados: `waf_group`: proteção básica da web. `custom_acl`: políticas de mitigação personalizadas. `whitelist`: lista de permissões.
PolicyStatus	string	Não	on	O status da política. Valores válidos: `on`: ativado. `off`: desativado.
OrderBy	string	Não	GmtModified	O campo pelo qual ordenar os resultados. Valores válidos: `GmtModified`, `PolicyId`, `PolicyName` e `PolicyStatus`.
Desc	Boolean	Não	false	A ordem de classificação. Valores válidos: `true`: descendente. `false` (padrão): ascendente.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de políticas de mitigação exibidas em cada página. Valor padrão: 20. Valores válidos: um número inteiro de 1 a 500.	20
RequestId	string	O ID da solicitação.	153ca2cd-3c01-44be-2e83-64dbc6c88630
PageNumber	integer	O número da página. Valores válidos: 1 a 100000. Valor padrão: 1.	1
TotalCount	integer	O número total de políticas de mitigação.	15
Policies	array<object>	A lista de políticas de mitigação.
	object
PolicyStatus	string	O status da política de mitigação. O valor é o mesmo que o campo PolicyStatus no parâmetro de solicitação QueryArgs.	on
DefenseScene	string	O cenário de mitigação. O valor é o mesmo que o campo DefenseScenes no parâmetro de solicitação QueryArgs.	custom_acl
DomainCount	integer	O número de nomes de domínio que usam a política de mitigação.	22
PolicyName	string	O nome da política de mitigação.	policy_test
PolicyId	integer	O ID da política de mitigação.	100001
RuleCount	integer	O número de regras na política de mitigação.	9
GmtModified	string	A hora da última modificação da política. A hora está no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-12-29T17:08:45Z
PolicyType	string	Indica se a política é uma política de mitigação padrão. O valor é o mesmo que o campo PolicyType no parâmetro de solicitação QueryArgs.	default

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 20,
  "RequestId": "153ca2cd-3c01-44be-2e83-64dbc6c88630",
  "PageNumber": 1,
  "TotalCount": 15,
  "Policies": [
    {
      "PolicyStatus": "on",
      "DefenseScene": "custom_acl",
      "DomainCount": 22,
      "PolicyName": "policy_test",
      "PolicyId": 100001,
      "RuleCount": 9,
      "GmtModified": "2021-12-29T17:08:45Z",
      "PolicyType": "default"
    }
  ]
}

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.