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

Consulta uma lista de modelos de proteção por paginaçã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:DescribeDefenseTemplates

list

*Todos os recursos.

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TemplateIds	string	Não	Os IDs dos modelos de proteção a serem consultados. Você pode especificar este parâmetro para consultar os recursos protegidos associados a vários modelos de proteção. Separe vários IDs de modelo com vírgulas (,).	189731,189539,189538,189531,189540,189542,189541
TemplateName	string	Não	O nome do modelo de proteção a ser consultado.	test
InstanceId	string	Sim	O ID da instância do WAF. Nota Você pode chamar DescribeInstance para consultar o ID da instância atual do WAF.	waf_v3prepaid_public_cn-pe33b****03
TemplateId	integer	Não	O ID do modelo de proteção.	39395
TemplateType	string	Não	O tipo de modelo do modelo de proteção. Valores válidos: user_default: proteção padrão. user_custom: proteção personalizada.	user_default
DefenseScene	string	Não	O cenário de proteção. Para obter mais informações, consulte o parâmetro DefenseScene em CreateDefenseRule.	region_block
Resource	string	Não	O nome do objeto protegido, o nome do grupo de objetos protegidos ou o ID do ativo protegido. Nota Este parâmetro é usado em conjunto com o parâmetro ResourceType. Ambos os parâmetros devem ter valores para que a filtragem tenha efeito.	ruiqiu.cc-ecs
ResourceType	string	Não	O tipo do recurso protegido. Nota Este parâmetro é usado em conjunto com o parâmetro Resource. Ambos os parâmetros devem ter valores para que a filtragem tenha efeito. Valores válidos: single : (Padrão) objeto protegido. asset : ativo protegido. group : grupo de objetos protegidos.	single
DefenseSubScene	string	Não	O subcenário do modelo de proteção. Valores válidos: web: modelo de cenário de proteção web de gerenciamento de bots. app: modelo de cenário de proteção de aplicativo de gerenciamento de bots. basic: modelo de proteção básica de gerenciamento de bots. bot_custom_acl: modelo de proteção de regra personalizada avançada de gerenciamento de bots.	basic
PageNumber	integer	Não	O número da página a ser retornado em uma solicitação de paginação. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página durante a paginação. Valor padrão: 20.	10
RegionId	string	Não	A região onde a instância do WAF está implantada. 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-acfmvyknl****fa

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	4F26D2F1-E288-5104-8518-05E240E337A4
Templates	array<object>	A lista de modelos de proteção.
	array<object>	O modelo de proteção.
DefenseScene	string	O cenário de proteção do WAF. Valores válidos: waf_group: proteção básica. antiscan: proteção contra varredura. ip_blacklist: lista de bloqueio de IPs. custom_acl: regra personalizada. whitelist: lista de permissões. region_block: lista de bloqueio de localizações. custom_response: resposta personalizada. cc: mitigação de inundação HTTP. tamperproof: proteção contra adulteração web. dlp: prevenção contra vazamento de dados. bot_manager: novo gerenciamento de bots.	whitelist
DefenseSubScene	string	O subcenário do modelo de proteção. Valores válidos: web: modelo de cenário de proteção web de gerenciamento de bots. app: modelo de cenário de proteção de aplicativo de gerenciamento de bots. basic: modelo de proteção básica de gerenciamento de bots. bot_custom_acl: modelo de proteção de regra personalizada avançada de gerenciamento de bots.	basic
Description	string	A descrição do modelo.	testTemplate
Detail	object	As informações detalhadas do modelo. Para obter mais informações, consulte o parâmetro Detail em CreateDefenseTemplate.	{"trafficFeature":"{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"}
GmtModified	integer	A hora em que o modelo de proteção foi modificado. O valor é um carimbo de data/hora em milissegundos.	1683776070000
TemplateId	integer	O ID do modelo de proteção.	56477
TemplateName	string	O nome do modelo de proteção.	template-blockarea1
TemplateOrigin	string	A origem do modelo de proteção. O valor custom indica que o modelo é definido pelo usuário.	custom
TemplateStatus	integer	O status do modelo de proteção. Valores válidos: 0: desativado. 1: ativado.	1
TemplateType	string	O tipo de modelo do modelo de proteção. Valores válidos: user_default: proteção padrão. user_custom: proteção personalizada.	user_custom
TotalCount	integer	O número total de entradas retornadas.	100

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "4F26D2F1-E288-5104-8518-05E240E337A4",
  "Templates": [
    {
      "DefenseScene": "whitelist",
      "DefenseSubScene": "basic",
      "Description": "testTemplate",
      "Detail": {
        "trafficFeature": "{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"
      },
      "GmtModified": 1683776070000,
      "TemplateId": 56477,
      "TemplateName": "template-blockarea1",
      "TemplateOrigin": "custom",
      "TemplateStatus": 1,
      "TemplateType": "user_custom"
    }
  ],
  "TotalCount": 100
}

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.