Criação de uma regra de lista branca de proteção global (Anteriormente mascaramento de alarme falso)
Função
Criação de uma regra de lista branca de proteção global (Anteriormente mascaramento de alarme falso)
URI
POST /v1/{project_id}/waf/policy/{policy_id}/ignore
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. |
policy_id |
Sim |
String |
ID da política. Ele pode ser obtido chamando a API ListPolicy. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enterprise_project_id |
Não |
String |
Você pode obter o ID chamando a API ListEnterpriseProject do EPS. |
Parâmetros 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âmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
domain |
Sim |
Array of strings |
Nome de domínio ou site a ser protegido. Se o comprimento da matriz for 0, a regra entrará em vigor para todos os nomes de domínio ou sites. |
conditions |
Sim |
Array of CreateCondition objects |
Lista de Condição |
mode |
Sim |
Integer |
O valor é fixado em 1, indicando regras de mascaramento de alarme falso v2. A v1 é usada apenas para compatibilidade com versões anteriores, e as regras de alarme falso não podem ser criadas na v1. |
rule |
Sim |
String |
Itens a serem mascarados. Você pode fornecer vários itens e separá-los com ponto e vírgula (;).
|
advanced |
Não |
Array of Advanced objects |
Configurações avançadas |
description |
Não |
String |
Descrição de uma regra de mascaramento |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
category |
Sim |
String |
Tipo de campo. O valor pode ser ip, url, params, cookie, ou header. |
contents |
Sim |
Array of strings |
Conteúdo. O comprimento da matriz é limitado a 1. O formato do conteúdo varia dependendo do tipo de campo. Por exemplo, se o tipo de campo for ip, o valor deverá ser um endereço IP ou intervalo de endereços IP. Se o tipo de campo for url, o valor deve estar no formato de URL padrão. Se o tipo de campo for params, cookie, ou header, o formato do conteúdo não é limitado. |
logic_operation |
Sim |
String |
A lógica de correspondência varia dependendo do tipo de campo. Por exemplo, se o tipo de campo for ip, a lógica pode ser equal ou not_equal. Se o tipo do campo for url, params, cookie, ou header, a lógica pode ser equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix. |
check_all_indexes_logic |
Não |
Integer |
Este parâmetro é reservado e pode ser ignorado. |
index |
Não |
String |
Se o tipo de campo for ip e o subcampo for o endereço IP do cliente, o parâmetro index não será necessário. Se o tipo de subcampo for X-Forwarded-For, o valor será x-forwarded-for. Se o tipo de campo for params, header, ou cookie, e o subcampo for definido pelo usuário, o valor do index será o subcampo definido pelo usuário. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
index |
Não |
String |
Tipo de campo. Os seguintes tipos de campo são suportados: Params, Cookie, Header, Body e Multipart.
|
contensts |
Não |
Array of strings |
Subcampo do tipo de campo especificado. O valor padrão é all. |
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da regra |
policyid |
String |
ID da política |
timestamp |
Long |
Timestamp a regra foi criada. |
description |
String |
Descrição da regra |
status |
Integer |
Status da regra. O valor pode ser 0 ou 1.
|
rule |
String |
ID da regra incorporada a ser mascarada. Você pode consultar a ID da regra escolhendo Policies > Policy Name > Basic Web Protection > Protection Rules no console do WAF ou na página de detalhes do evento. |
mode |
Integer |
O valor é fixado em 1, indicando que as regras de mascaramento de alarme falso v2 são usadas. A v1 é usada apenas para compatibilidade com versões anteriores, e as regras de alarme falso não podem ser criadas na v1. |
conditions |
Array of Condition objects |
Lista de Condição |
advanced |
Array of Advanced objects |
Configurações avançadas |
domain |
Array of strings |
Nome de domínio ou site protegido |
Parâmetro |
Tipo |
Descrição |
---|---|---|
category |
String |
Tipo de campo. O valor pode ser ip, url, params, cookie, ou header. |
contents |
Array of strings |
Conteúdo. O comprimento da matriz deve ser 1. O formato do conteúdo varia de acordo com os tipos de campo. Por exemplo, se o tipo de campo for ip, o valor deverá ser um endereço IP ou intervalo de endereços IP. Se o tipo de campo for url, o valor deve ser um URL no formato padrão. Se o tipo de campo for parâmetros, cookie ou cabeçalho, o formato do conteúdo não é limitado. |
logic_operation |
String |
A lógica de correspondência varia dependendo do tipo de campo. Por exemplo, se o tipo de campo for ip, a lógica pode ser equal ou not_equal. Se o tipo do campo for url, params, cookie, ou header, a lógica pode ser equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix. |
check_all_indexes_logic |
Integer |
Este parâmetro é reservado e pode ser ignorado. |
index |
String |
Se o tipo de campo for ip e o subcampo for o endereço IP do cliente, o parâmetro index não existirá. Se o tipo de subcampo for X-Forwarded-For, o valor será x-forwarded-for. Se o tipo de campo for params, header, ou cookie, e o subcampo for definido pelo usuário, o valor de index será o subcampo definido pelo usuário. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
index |
String |
Tipo de campo. Os seguintes tipos de campo são suportados: Params, Cookie, Header, Body e Multipart.
|
contensts |
Array of strings |
Subcampo do tipo de campo especificado. O valor padrão é all. |
Código de estado: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro |
error_msg |
String |
Mensagem de erro |
Código de estado: 401
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro |
error_msg |
String |
Mensagem de erro |
Código de estado: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro |
error_msg |
String |
Mensagem de erro |
Exemplos de solicitações
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0 { "domain" : [ "we.test.418lab.cn" ], "conditions" : [ { "category" : "url", "logic_operation" : "contain", "contents" : [ "x.x.x.x" ], "index" : null } ], "mode" : 1, "description" : "demo", "rule" : "091004" }
Exemplo de respostas
Código de estado: 200
OK
{ "id" : "a57f20ced01e4e0d8bea8e7c49eea254", "policyid" : "f385eceedf7c4c34a4d1def19eafbe85", "timestamp" : 1650522310447, "description" : "demo", "status" : 1, "rule" : "091004", "mode" : 1, "conditions" : [ { "category" : "url", "contents" : [ "x.x.x.x" ], "logic_operation" : "contain" } ], "domain" : [ "we.test.418lab.cn" ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Falha na solicitação. |
401 |
O token não tem permissões necessárias. |
500 |
Erro de servidor interno. |
Códigos de erro
Consulte Códigos de erro.