Consulta de configurações de nome de domínio no modo dedicado
Função
Essa API é usada para consultar configurações de nomes de domínio protegidos com instâncias WAF dedicadas.
URI
GET /v1/{project_id}/premium-waf/host/{host_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. |
host_id |
Sim |
String |
ID do nome de domínio protegido pelo mecanismo WAF dedicado |
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 |
---|---|---|---|
Content-Type |
Sim |
String |
Tipo de conteúdo. Padrão: application/json;charset=utf8 |
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). |
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do nome de domínio |
hostname |
String |
Nome de domínio adicionado à instância dedicada do WAF |
protocol |
String |
Protocolo do cliente. o protocolo usado por um cliente (por exemplo, um navegador) para acessar seu site. |
server |
Array of PremiumWafServer objects |
Configuração do servidor de origem do nome de domínio protegido |
proxy |
Boolean |
Se um proxy é usado para o nome de domínio protegido.
|
locked |
Integer |
Este parâmetro é reservado, que será usado para congelar um nome de domínio. Padrão: 0 |
timestamp |
Long |
Hora em que o nome de domínio foi adicionado ao WAF. |
tls |
String |
Versão mínima do TLS. Você pode usar o TLS v1.0, TLS v1.1 ou TLS v1.2. O TLS v1.0 é usado por padrão. O parâmetro tls é exigido somente quando o protocolo do cliente é HTTPS. Valores de enumeração:
|
cipher |
String |
A cipher de parâmetro é necessária somente quando o protocolo do cliente é HTTPS. O valor pode ser cipher_1, cipher_2, cipher_3, cipher_4, ou cipher_default.
Valores de enumeração:
|
extend |
Map<String,String> |
Campo estendido, que é usado para salvar algumas informações de configuração sobre o nome de domínio protegido. |
flag |
Flag object |
Identificador especial, que é usado no console. |
description |
String |
Descrição do nome de domínio |
policyid |
String |
ID da política usada inicialmente para o nome de domínio. Você pode chamar a API ListPolicy para consultar a lista de políticas e exibir o ID da política específica. |
domainid |
String |
ID da conta, que é o mesmo que o ID da conta na página My Credentials. Para acessar esta página, faça login no console de gerenciamento do Huawei Cloud, passe o cursor sobre seu nome de usuário e clique em My Credentials na janela exibida. |
projectid |
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. |
enterprise_project_id |
String |
ID do projeto empresarial. Para obter a ID, faça login primeiro no console de gerenciamento do Huawei Cloud. Na barra de menus na parte superior da página, escolha Enterprise > Project Management. Em seguida, clique no nome do projeto e visualize o ID. |
certificateid |
String |
ID do certificado HTTPS. |
certificatename |
String |
Nome do certificado |
protect_status |
Integer |
Status do WAF do nome de domínio protegido.
|
access_status |
Integer |
Status de acesso ao nome de domínio. O valor pode ser 0 ou 1. 0: O tráfego do site não foi encaminhado para o WAF. 1: O tráfego do site foi encaminhado para o WAF. |
web_tag |
String |
Nome do site, que é o mesmo que o nome do site nos detalhes do nome de domínio no console do WAF. |
block_page |
BlockPage object |
Configuração da página de alarme |
traffic_mark |
TrafficMark object |
Identificador de tráfego |
timeout_config |
TimeoutConfig object |
Configurações de tempo limite |
access_progress |
Array of Access_progress objects |
Progresso do acesso, que é usado apenas para o novo console do WAF. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
front_protocol |
String |
Protocolo usado pelo cliente para solicitar acesso ao servidor de origem. Valores de enumeração:
|
back_protocol |
String |
Protocolo usado pelo WAF para encaminhar solicitações de clientes recebidas aos servidores de origem Valores de enumeração:
|
weight |
Integer |
Peso do servidor de origem. O algoritmo de balanceamento de carga encaminha solicitações para o servidor de origem com base no peso. O valor padrão é 1. Este campo não é incluído pelo WAF na nuvem. |
address |
String |
Endereço IP do servidor de origem solicitado pelo cliente |
port |
Integer |
Porta usada pelo WAF para encaminhar solicitações de clientes para o servidor de origem |
type |
String |
O endereço do servidor de origem é um endereço IPv4 ou IPv6. Valores de enumeração:
|
vpc_id |
String |
ID de VPC Para obter o ID da VPC, execute as seguintes etapas: Use um dos métodos a seguir para obter o ID da VPC.
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
pci_3ds |
String |
Se o site passa a verificação de certificação PCI 3DS.
Valores de enumeração:
|
pci_dss |
String |
Se o site passou na verificação de certificação PCI DSS.
Valores de enumeração:
|
cname |
String |
O registro CNAME que está sendo usado.
Valores de enumeração:
|
is_dual_az |
String |
Se o WAF suporta o Multi-AZ DR
Valores de enumeração:
|
ipv6 |
String |
Se a proteção IPv6 é suportada.
Valores de enumeração:
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
template |
String |
Nome do modelo |
custom_page |
CustomPage object |
Página de alarme personalizada |
redirect_url |
String |
URL da página redirecionada |
Parâmetro |
Tipo |
Descrição |
---|---|---|
status_code |
String |
Códigos de status |
content_type |
String |
O tipo de conteúdo da página de alarme personalizada. O valor pode ser text/html, text/xml, ou application/json. |
content |
String |
O conteúdo da página com base no tipo de página selecionado. Para obter detalhes, consulte o Guia de usuário do Web Application Firewall (WAF). |
Parâmetro |
Tipo |
Descrição |
---|---|---|
sip |
Array of strings |
Etiqueta IP. Campo do cabeçalho da solicitação HTTP do endereço IP original do cliente. |
cookie |
String |
Tag da sessão. Essa tag é usada por regras de origem de ataque conhecidas para bloquear ataques maliciosos com base em atributos de cookies. Esse parâmetro deve ser configurado em regras de origem de ataque conhecidas para bloquear solicitações com base em atributos de cookie. |
params |
String |
Tag do usuário. Essa tag é usada por regras de origem de ataque conhecidas para bloquear ataques maliciosos com base em atributos de params. Esse parâmetro deve ser configurado para bloquear solicitações com base nos atributos params. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
connect_timeout |
Integer |
Tempo limite para o WAF se conectar ao servidor de origem. |
send_timeout |
Integer |
Tempo limite para o WAF enviar solicitações ao servidor de origem. |
read_timeout |
Integer |
Tempo limite para o WAF receber respostas do servidor de origem. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
step |
Integer |
Etapa |
status |
Integer |
Estado. O valor pode ser 0 ou 1.
|
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
GET https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}?enterprise_project_id=0
Exemplo de respostas
Código de estado: 200
OK
{ "id" : "ee896796e1a84f3f85865ae0853d8974", "hostname" : "www.demo.com", "protocol" : "HTTPS", "server" : [ { "address" : "1.2.3.4", "port" : 443, "type" : "ipv4", "weight" : 1, "front_protocol" : "HTTPS", "back_protocol" : "HTTPS", "vpc_id" : "ebfc553a-386d-4746-b0c2-18ff3f0e903d" } ], "proxy" : false, "locked" : 0, "timestamp" : 1650593801380, "tls" : "TLS v1.0", "cipher" : "cipher_1", "flag" : { "pci_3ds" : "false", "pci_dss" : "false" }, "description" : "", "policyid" : "df15d0eb84194950a8fdc615b6c012dc", "domainid" : "0ee78615ca08419f81f539d97c9ee353", "projectid" : "550500b49078408682d0d4f7d923f3e1", "protect_status" : 1, "access_status" : 0, "certificateid" : "360f992501a64de0a65c50a64d1ca7b3", "certificatename" : "certificatename75315" }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Pedido inválido |
401 |
O token não tem a permissão necessária. |
500 |
Erro de servidor interno. |
Códigos de erro
Consulte Códigos de erro.