Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Web Application Firewall> Referência de API> API> Gerenciamento de políticas> Consulta de lista de políticas de proteção

Atualizado em 2022-11-02 GMT+08:00

Ver PDF

Consulta de lista de políticas de proteção

Função

Essa API é usada para consultar a lista de políticas de proteção.

URI

GET /v1/{project_id}/waf/policy

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto. Para obtê-lo, vá para o console de gerenciamento do Huawei Cloud e passe o cursor sobre seu nome de usuário. Na janela exibida, escolha My Credentials.Em seguida, na área Projects, visualize Project ID correspondente.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
enterprise_project_id	Não	String	Você pode obter o ID chamando a API ListEnterpriseProject do EPS.
page	Não	Integer	Número de página dos dados a serem retornados durante a consulta de paginação. O valor padrão é 1, indicando que os dados na primeira página são retornados. Padrão: 1
pagesize	Não	Integer	Número de resultados em cada página durante a consulta de paginação. Faixa de valor: 1 a 100. O valor padrão é 10, indicando que cada página contém 10 resultados. Padrão: 10
name	Não	String	Nome da política

Parâmetros de solicitação

**Tabela 3** Parâmetros de cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. Ele pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho da resposta).
Content-Type	Sim	String	Tipo de conteúdo. Padrão: application/json;charset=utf8

Parâmetros de resposta

Código de estado: 200

**Tabela 4** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
total	Integer	Número total de políticas
items	Array of PolicyResponse objects	Matriz de informações da política de proteção

**Tabela 5** PolicyResponse
Parâmetro	Tipo	Descrição
id	String	ID da política
name	String	Matriz de detalhes das políticas
level	Integer	Nível de proteção da proteção básica da Web 1: Baixo. Nesse nível de proteção, o WAF bloqueia apenas solicitações com recursos óbvios de ataque. Se um grande número de alarmes falsos tiver sido relatado, recomenda-se Low. 2: Médio. Esse nível de proteção atende aos requisitos de proteção da Web na maioria dos cenários. 3: Alto. Nesse nível de proteção, o WAF fornece a melhor proteção granular e pode interceptar ataques com recursos complexos de desvio, como ataques cibernéticos Jolokia, detecção de vulnerabilidades de interface de gateway comum (CGI) e ataques de injeção Druid SQL. Padrão: 2 Valores de enumeração: 1 2 3
full_detection	Boolean	O modo de detecção em Proteção Precisa. false: Detecção instantânea. Quando uma solicitação atinge as condições de bloqueio na Proteção precisa, o WAF encerra as verificações e bloqueia a solicitação imediatamente. true: Detecção completa. Se uma solicitação atingir as condições de bloqueio em Proteção precisa, o WAF não bloqueará a solicitação imediatamente. Em vez disso, ele bloqueia as solicitações até que outras verificações sejam concluídas.
robot_action	Action object	Ações de proteção para cada regra na proteção anti-crawler.
action	PolicyAction object	Ação Protetora
options	PolicyOption object	Se um tipo de proteção está ativado na política de proteção.
modulex_options	Map<String,Object>	Configurações sobre controle de acesso inteligente. Atualmente, esse recurso ainda está na fase de teste beta aberto (OBT) e disponível em alguns sites.
hosts	Array of strings	Matriz dos ID de nome de domínio protegidas pela política.
bind_host	Array of BindHost objects	Matriz de nomes de domínio protegidos com a política de proteção. Comparado com o campo hosts, este campo contém mais detalhes.
extend	Map<String,String>	Campo estendido, que é usado para armazenar a configuração de regras da proteção básica da Web.
timestamp	Long	Hora em que uma política é criada

**Tabela 6** Ação
Parâmetro	Tipo	Descrição
category	String	Ação de proteção para regras anti-crawler baseadas em recursos: log: O WAF registra apenas os ataques descobertos. block: WAF bloqueia ataques descobertos.

**Tabela 7** PolicyAction
Parâmetro	Tipo	Descrição
category	String	Ação básica de proteção da web. O valor pode ser log ou block. log: WAF apenas registra ataques descobertos. block: WAF bloqueia ataques descobertos. Valores de enumeração: block log

**Tabela 8** PolicyOption
Parâmetro	Tipo	Descrição
webattack	Boolean	Se a proteção básica da Web está ativada Valores de enumeração: true false
common	Boolean	Se a verificação geral está ativada Valores de enumeração: true false
crawler	Boolean	Este parâmetro é reservado. O valor deste parâmetro é fixado em true. Você pode ignorar esse parâmetro. Valores de enumeração: true false
crawler_engine	Boolean	Se o motor de busca está ativado Valores de enumeração: true false
crawler_scanner	Boolean	Se a detecção anti-crawler está ativada Valores de enumeração: true false
crawler_script	Boolean	Se o JavaScript anti-crawler está ativado Valores de enumeração: true false
crawler_other	Boolean	Se outra verificação de crawler está ativada Valores de enumeração: true false
webshell	Boolean	Se a detecção de webshell está ativada Valores de enumeração: true false
cc	Boolean	Se as regras de proteção contra ataques da CC estão ativadas Valores de enumeração: true false
custom	Boolean	Se a proteção precisa está ativada Valores de enumeração: true false
whiteblackip	Boolean	Se a proteção de lista negra e lista branca está ativada Valores de enumeração: true false
geoip	Boolean	Se o controle de acesso de geolocalização está ativado Valores de enumeração: true false
ignore	Boolean	Se o mascaramento de alarme falso está ativado Valores de enumeração: true false
privacy	Boolean	Se o mascaramento de dados está ativado Valores de enumeração: true false
antitamper	Boolean	Se a proteção contra adulteração da Web está ativada Valores de enumeração: true false
antileakage	Boolean	Se a prevenção de vazamento de informações está ativada Valores de enumeração: true false
bot_enable	Boolean	Se a proteção anti-crawler está ativada Valores de enumeração: true false
modulex_enabled	Boolean	Se a proteção contra ataques CC para moduleX está ativada. Esse recurso está no teste beta aberto (OBT). Durante o OBT, somente o modo de registro somente é suportado. Valores de enumeração: true false

**Tabela 9** BindHost
Parâmetro	Tipo	Descrição
id	String	ID do nome de domínio
hostname	String	Nome de domínio
waf_type	String	Modo de implantação da instância do WAF usado para o nome de domínio. O valor pode ser cloud para WAF na nuvem ou premium para instâncias dedicadas do WAF.
mode	String	Este parâmetro é requerido apenas pelo modo dedicado.

Código de estado: 400

**Tabela 10** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro
error_msg	String	Mensagem de erro

Código de estado: 401

**Tabela 11** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro
error_msg	String	Mensagem de erro

Código de estado: 500

**Tabela 12** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro
error_msg	String	Mensagem de erro

Exemplos de solicitações

GET https://{Endpoint}/v1/{project_id}/waf/policy?enterprise_project_id=0

Exemplo de respostas

Código de estado: 200

Solicitação bem-sucedida.

{
  "total" : 1,
  "items" : [ {
    "id" : "41cba8aee2e94bcdbf57460874205494",
    "name" : "policy_2FHwFOKz",
    "level" : 2,
    "action" : {
      "category" : "log"
    },
    "options" : {
      "webattack" : true,
      "common" : true,
      "crawler" : true,
      "crawler_engine" : false,
      "crawler_scanner" : true,
      "crawler_script" : false,
      "crawler_other" : false,
      "webshell" : false,
      "cc" : true,
      "custom" : true,
      "whiteblackip" : true,
      "geoip" : true,
      "ignore" : true,
      "privacy" : true,
      "antitamper" : true,
      "antileakage" : false,
      "bot_enable" : true,
      "modulex_enabled" : false
    },
    "hosts" : [ ],
    "extend" : { },
    "timestamp" : 1650527546218,
    "full_detection" : false,
    "bind_host" : [ ]
  } ]
}