Todos os produtos
Search

Este produto

    Web Application Firewall:CreateDefenseTemplate

    Central de documentação

    Web Application Firewall:CreateDefenseTemplate

    Última atualização: Sep 09, 2026

    Cria um 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:CreateDefenseTemplate

    create

    *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 obter o ID da instância atual do WAF.

    waf_cdnsdf3****
    TemplateName

    string

    Sim

    O nome do modelo de proteção a ser criado. O nome deve ter de 1 a 255 caracteres e pode conter caracteres chineses, letras, dígitos, sublinhados (_), pontos (.) e hifens (-).

    Nota

    Os nomes dos modelos devem ser exclusivos dentro do mesmo cenário de proteção (DefenseScene).

    test221
    TemplateType

    string

    Sim

    O tipo do modelo de proteção a ser criado. Valores válidos:

    • user_default: proteção padrão.

    • user_custom: proteção personalizada.

    user_default
    TemplateStatus

    integer

    Sim

    O status do modelo de proteção a ser criado. Valores válidos:

    • 0: Desativado.

    • 1: Ativado.

    1
    DefenseScene

    string

    Sim

    O cenário de proteção. Para mais informações, consulte o parâmetro DefenseScene em CreateDefenseRule.

    waf_group
    TemplateOrigin

    string

    Sim

    A origem do modelo de proteção a ser criado. Defina o valor como custom, que indica definido pelo usuário.

    custom
    DefenseSubScene

    string

    Não

    O subcenário do modelo de proteção. Este parâmetro é suportado apenas para o cenário de gerenciamento avançado de bots.

    Valores válidos:

    • app :

      Modelo de cenário de aplicativo.

    • web :

      Modelo de cenário web.

    • bot_custom_acl :

      Modelo de regra personalizada avançada.

    web
    Description

    string

    Não

    A descrição do modelo de proteção a ser criado.

    test
    RegionId

    string

    Não

    As informações detalhadas do modelo, que consistem em uma string formatada em JSON. Diferentes pares chave-valor representam diferentes atributos do objeto protegido. Para mais informações, consulte a descrição de Detail.

    Nota

    Este parâmetro se aplica apenas à nova versão da proteção básica (waf_base) e à nova versão dos cenários de proteção de gerenciamento de bots (bot_manager). Este parâmetro é obrigatório para o cenário de proteção da nova versão de gerenciamento de bots (bot_manager).

    {"trafficFeature":"{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"}
    ResourceManagerResourceGroupId

    string

    Não

    Especifica se o modo dry run deve ser ativado. Se você não especificar este parâmetro, uma solicitação normal será enviada. Valores válidos:

    • true: Uma solicitação de dry run é enviada. O sistema verifica se a solicitação atende às condições de execução sem realizar a operação especificada. Se o dry run falhar, o código de erro correspondente será retornado. Se o dry run for bem-sucedido, o código de erro Defense.Control.DryRunOperation será retornado.

    • false: Uma solicitação normal é enviada. A operação especificada é executada após a solicitação passar na verificação.

    false
    UnbindResources

    array

    Não

    A região onde a instância do WAF está localizada. Valores válidos:

    • cn-hangzhou: parte continental da China.

    • ap-southeast-1: fora da parte continental da China.

    cn-hangzhou

    string

    Não

    O objeto protegido a ser desvinculado.

    abc
    UnbindResourceGroups

    array

    Não

    O ID do grupo de recursos do Alibaba Cloud.

    rg-acfm***q

    string

    Não

    O grupo de objetos protegidos a ser desvinculado.

    group1

    Não

    Os objetos protegidos a serem desvinculados ao criar um modelo de proteção padrão. Use o formato ["XX1","XX2",...].

    Nota

    Este parâmetro entra em vigor apenas ao criar um modelo padrão (quando TemplateType é definido como user_default).

    Não

    Os grupos de objetos protegidos a serem desvinculados ao criar um modelo de proteção padrão. Use o formato ["group1","group2",...].

    Nota

    Este parâmetro entra em vigor apenas ao criar um modelo padrão (quando TemplateType é definido como user_default).

    Descrição do parâmetro Detail

    O conteúdo do parâmetro Detail varia dependendo do cenário de proteção (DefenseScene) do modelo de proteção.

    Nova versão da proteção principal da Web (waf_base)

    Descrição do parâmetro

    NomeTipoObrigatórioExemploDescrição
    aiWhitelistStatusintegerNão1O status do mecanismo de lista de permissões inteligente para a nova versão da proteção básica. Valores válidos:
    - 0 (padrão): Desativado.
    - 1: Ativado.




    Exemplo

    {
  "aiWhitelistStatus": 1
}

    Nova versão do gerenciamento de bots (bot_manager)

    Descrição do parâmetro

    NomeTipoObrigatórioExemploDescrição
    trafficFeatureStringNão{"global":1,"excludeStatus":1,"staticFile":".css,.js,.jpg,……"}As configurações de parâmetro do escopo de proteção do modelo de proteção de gerenciamento de bots, descritas no formato de string JSON. Este parâmetro é obrigatório quando o cenário de proteção (DefenseScene) é bot_manager. Para mais informações, consulte configurações detalhadas do parâmetro trafficFeature.

    configurações detalhadas do parâmetro trafficFeature

    NomeTipoObrigatórioExemploDescrição
    globalIntegerSim1Especifica se o escopo de proteção cobre todo o site. Valores válidos:
    - 0: Escopo de proteção personalizado. Use conditions para especificar as características de tráfego que entram em vigor.
    - 1: Proteção global. O modelo entra em vigor em todas as solicitações para o objeto protegido.




    excludeStatusIntegerNão1Especifica se os recursos estáticos devem ser excluídos. As solicitações que correspondem aos sufixos de arquivo estático especificados em staticFile não entram na proteção contra bots. Valores válidos:
    - 0: Os recursos estáticos não são excluídos.
    - 1: Os recursos estáticos são excluídos. Use staticFile para especificar os sufixos de arquivo estático a serem excluídos.




    staticFileStringNão.7z,.aac,.css,.js,.jpg,.png,.pdf,.zip,……A lista de sufixos de arquivo estático a serem excluídos, representada como uma string separada por vírgulas (,). Cada sufixo começa com um ponto (.). Configure este parâmetro apenas quando excludeStatus estiver definido como 1.
    conditionsArrayNão[{"key":"URL","opValue":"not-contain","values":"test"}]As características de tráfego para o escopo de proteção personalizado, descritas no formato de string JSON. Este parâmetro pode ser configurado apenas quando global estiver definido como 0. Para mais informações, consulte as configurações do parâmetro conditions em Configurações de parâmetro de regra de proteção.

    Exemplo

    {
  "trafficFeature": "{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"
}

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    A estrutura da resposta.

    RequestId

    string

    O ID da solicitação.

    F48ABDF7-D777-5F26-892A-57349765D7A9
    TemplateId

    integer

    O ID do modelo de proteção.

    2212

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "F48ABDF7-D777-5F26-892A-57349765D7A9",
  "TemplateId": 2212
}

    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.