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

Consulta um único modelo 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:DescribeDefenseTemplate

get

*Todos os recursos.

*

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 Você pode chamar DescribeInstance para consultar o ID da instância atual do WAF.	waf_cdnsdf3****
TemplateId	integer	Sim	O ID do modelo de proteção a ser consultado.	1333
RegionId	string	Não	A região onde a instância do WAF está implantada. 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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Template	object	As informações do modelo.
DefenseScene	string	O cenário de proteção. Para obter mais informações, consulte o parâmetro DefenseScene em CreateDefenseRule.	waf_group
DefenseSubScene	string	O subcenário do modelo de proteção. Valores válidos: web: modelo de cenário de proteção web para gerenciamento de bots. app: modelo de cenário de proteção de aplicativo para gerenciamento de bots. basic: modelo de proteção básica para gerenciamento de bots. bot_custom_acl: modelo de proteção de regra personalizada avançada para gerenciamento de bots.	app
Description	string	A descrição do modelo de proteção.	teste
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\":\"teste\"}]}"}
GmtModified	integer	A hora em que o modelo de proteção foi modificado pela última vez.	1665283642000
TemplateId	integer	O ID do modelo de regra de proteção.	10097
TemplateName	string	O nome do modelo.	test0621
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 de proteção. Valores válidos: user_default: proteção padrão do usuário. user_custom: proteção personalizada do usuário.	user_default

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Template": {
    "DefenseScene": "waf_group",
    "DefenseSubScene": "app",
    "Description": "test",
    "Detail": {
      "trafficFeature": "{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"
    },
    "GmtModified": 1665283642000,
    "TemplateId": 10097,
    "TemplateName": "test0621",
    "TemplateOrigin": "custom",
    "TemplateStatus": 1,
    "TemplateType": "user_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.