Atualização de uma política de proteção
Função
Esta API é usada para atualizar uma política. O corpo da solicitação pode conter apenas a parte a ser atualizada.
URI
PATCH /v1/{project_id}/waf/policy/{policy_id}
|
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 |
|---|---|---|---|
|
name |
Não |
String |
Matriz de detalhes das políticas |
|
level |
Não |
Integer |
Nível de proteção da proteção básica da Web
Padrão: 2 Valores de enumeração:
|
|
full_detection |
Não |
Boolean |
O modo de detecção em Proteção Precisa.
|
|
robot_action |
Não |
Action object |
Ações de proteção para cada regra na proteção anti-crawler. |
|
action |
Não |
PolicyAction object |
Ação Protetora |
|
options |
Não |
PolicyOption object |
Se um tipo de proteção está ativado na política de proteção. |
|
modulex_options |
Não |
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 |
Não |
Array of strings |
Matriz dos ID de nome de domínio protegidas pela política. |
|
bind_host |
Não |
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 |
Não |
Map<String,String> |
Campo estendido, que é usado para armazenar a configuração de regras da proteção básica da Web. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
category |
Não |
String |
Ação de proteção para regras anti-crawler baseadas em recursos:
|
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
category |
Não |
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:
|
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
webattack |
Não |
Boolean |
Se a proteção básica da Web está ativada Valores de enumeração:
|
|
common |
Não |
Boolean |
Se a verificação geral está ativada Valores de enumeração:
|
|
crawler |
Não |
Boolean |
Este parâmetro é reservado. O valor deste parâmetro é fixado em true. Você pode ignorar esse parâmetro. Valores de enumeração:
|
|
crawler_engine |
Não |
Boolean |
Se o motor de busca está ativado Valores de enumeração:
|
|
crawler_scanner |
Não |
Boolean |
Se a detecção anti-crawler está ativada Valores de enumeração:
|
|
crawler_script |
Não |
Boolean |
Se o JavaScript anti-crawler está ativado Valores de enumeração:
|
|
crawler_other |
Não |
Boolean |
Se outra verificação de crawler está ativada Valores de enumeração:
|
|
webshell |
Não |
Boolean |
Se a detecção de webshell está ativada Valores de enumeração:
|
|
cc |
Não |
Boolean |
Se as regras de proteção contra ataques da CC estão ativadas Valores de enumeração:
|
|
custom |
Não |
Boolean |
Se a proteção precisa está ativada Valores de enumeração:
|
|
whiteblackip |
Não |
Boolean |
Se a proteção de blacklist e whitelist está ativada Valores de enumeração:
|
|
geoip |
Não |
Boolean |
Se o controle de acesso de geolocalização está ativado Valores de enumeração:
|
|
ignore |
Não |
Boolean |
Se o mascaramento de alarme falso está ativado Valores de enumeração:
|
|
privacy |
Não |
Boolean |
Se o mascaramento de dados está ativado Valores de enumeração:
|
|
antitamper |
Não |
Boolean |
Se a proteção contra adulteração da Web está ativada Valores de enumeração:
|
|
antileakage |
Não |
Boolean |
Se a prevenção de vazamento de informações está ativada Valores de enumeração:
|
|
bot_enable |
Não |
Boolean |
Se a proteção anti-crawler está ativada Valores de enumeração:
|
|
modulex_enabled |
Não |
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:
|
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
id |
Não |
String |
ID do nome de domínio |
|
hostname |
Não |
String |
Nome de domínio |
|
waf_type |
Não |
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 |
Não |
String |
Este parâmetro é requerido apenas pelo modo dedicado. |
Parâmetros de resposta
Código de estado: 200
|
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
Padrão: 2 Valores de enumeração:
|
|
full_detection |
Boolean |
O modo de detecção em Proteção Precisa.
|
|
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 |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
category |
String |
Ação de proteção para regras anti-crawler baseadas em recursos:
|
|
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:
|
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
webattack |
Boolean |
Se a proteção básica da Web está ativada Valores de enumeração:
|
|
common |
Boolean |
Se a verificação geral está ativada Valores de enumeração:
|
|
crawler |
Boolean |
Este parâmetro é reservado. O valor deste parâmetro é fixado em true. Você pode ignorar esse parâmetro. Valores de enumeração:
|
|
crawler_engine |
Boolean |
Se o motor de busca está ativado Valores de enumeração:
|
|
crawler_scanner |
Boolean |
Se a detecção anti-crawler está ativada Valores de enumeração:
|
|
crawler_script |
Boolean |
Se o JavaScript anti-crawler está ativado Valores de enumeração:
|
|
crawler_other |
Boolean |
Se outra verificação de crawler está ativada Valores de enumeração:
|
|
webshell |
Boolean |
Se a detecção de webshell está ativada Valores de enumeração:
|
|
cc |
Boolean |
Se as regras de proteção contra ataques da CC estão ativadas Valores de enumeração:
|
|
custom |
Boolean |
Se a proteção precisa está ativada Valores de enumeração:
|
|
whiteblackip |
Boolean |
Se a proteção de lista negra e lista branca está ativada Valores de enumeração:
|
|
geoip |
Boolean |
Se o controle de acesso de geolocalização está ativado Valores de enumeração:
|
|
ignore |
Boolean |
Se o mascaramento de alarme falso está ativado Valores de enumeração:
|
|
privacy |
Boolean |
Se o mascaramento de dados está ativado Valores de enumeração:
|
|
antitamper |
Boolean |
Se a proteção contra adulteração da Web está ativada Valores de enumeração:
|
|
antileakage |
Boolean |
Se a prevenção de vazamento de informações está ativada Valores de enumeração:
|
|
bot_enable |
Boolean |
Se a proteção anti-crawler está ativada Valores de enumeração:
|
|
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:
|
|
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
|
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
PATCH https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}?enterprise_project_id=0
{
"options" : {
"whiteblackip" : false
}
}
Exemplo de respostas
Código de estado: 200
OK
{
"id" : "38ff0cb9a10e4d5293c642bc0350fa6d",
"name" : "demo",
"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,
"precise" : false,
"whiteblackip" : false,
"geoip" : true,
"ignore" : true,
"privacy" : true,
"antitamper" : true,
"anticrawler" : false,
"antileakage" : false,
"followed_action" : false,
"bot_enable" : true
},
"hosts" : [ "c0268b883a854adc8a2cd352193b0e13" ],
"timestamp" : 1650529538732,
"full_detection" : false,
"bind_host" : [ {
"id" : "c0268b883a854adc8a2cd352193b0e13",
"hostname" : "www.demo.com",
"waf_type" : "cloud"
} ],
"share_info" : {
"is_receiver" : false,
"provider_display" : {
"share_count" : 0,
"accept_count" : 0,
"process_status" : 0
}
}
}
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.