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 sites protegidos no modo nuvem/ Consulta de detalhes sobre um nome de domínio por ID de nome de domínio no modo nuvem
Atualizado em 2022-11-02 GMT+08:00

Consulta de detalhes sobre um nome de domínio por ID de nome de domínio no modo nuvem

Função

Consulta de detalhes sobre um nome de domínio por ID de nome de domínio no modo nuvem

URI

GET /v1/{project_id}/waf/instance/{instance_id}

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.

instance_id

Sim

String

ID do nome de domínio. Ele pode ser obtido chamando a API ListHost.

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.

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

id

String

ID do nome de domínio

hostname

String

Nome de domínio adicionado ao WAF na nuvem.

policyid

String

ID da política usada para o nome de domínio.

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.

protocol

String

Tipo de protocolo backend. O valor pode ser HTTPS, HTTP ou HTTP&HTTPS.

server

Array of CloudWafServer 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.

  • false: Nenhum proxy é usado.
  • true: Um proxy é usado.

protect_status

Integer

Status do WAF do nome de domínio protegido.

  • -1: A proteção WAF é ignorada. As solicitações do nome de domínio são enviadas diretamente para o servidor de backend e não passam pelo WAF.
  • 0: A proteção WAF está suspensa. O WAF encaminha apenas solicitações destinadas ao nome de domínio e não detecta ataques.
  • 1: A proteção WAF está ativada. O WAF detecta ataques com base na política configurada.

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.

access_code

String

Prefixo CNAME

locked

Integer

Este parâmetro é reservado, que será usado para congelar um nome de domínio.

timestamp

Long

Timestamp (ms) quando o nome de domínio protegido é criado.

certificateid

String

ID do certificado HTTPS.

certificatename

String

Nome do certificado

tls

String

Versão mínima do TLS. O valor pode ser TLS v1.0, TLS v1.1, ou TLS v1.2. O TLS v1.0 é usado por padrão.

Valores de enumeração:

  • TLS v1.0
  • TLS v1.1
  • TLS v1.2
  • TLS v1.3

cipher

String

Suíte Cipher. O valor pode ser cipher_1, cipher_2, cipher_3, cipher_4, ou cipher_default: cipher_1: ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH

  • cipher_2: EECDH+AESGCM:EDH+AESGCM
  • cipher_3: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH
  • cipher_4: ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH
  • cipher_default: ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM.

Valores de enumeração:

  • cipher_1
  • cipher_2
  • cipher_3
  • cipher_4
  • cipher_default

block_page

BlockPage object

Configuração da página de alarme

extend

Map<String,String>

Campo estendido, que é usado para salvar algumas informações de configuração sobre o nome de domínio protegido.

traffic_mark

TrafficMark object

Identificador de tráfego

circuit_breaker

CircuitBreaker object

Configuração do disjuntor

lb_algorithm

String

Algoritmos de balanceamento de carga. Este parâmetro está incluído apenas na edição profissional (antiga edição empresarial) e edição platina (antiga edição premium).

  • Source IP hash: As solicitações de um determinado endereço IP são encaminhadas para o mesmo servidor.
  • Weighted round robin: Todas as solicitações são distribuídas aos servidores de origem, por sua vez, com base no peso atribuído a cada servidor.
  • Session hash: Solicitações com um ID de sessão específico são encaminhadas para o mesmo servidor de origem. Certifique-se de que os identificadores de tráfego para fontes de ataque conhecidas estejam configurados depois que o nome de domínio foi adicionado ao WAF. Caso contrário, a configuração de hash da sessão não terá efeito.

Valores de enumeração:

  • ip_hash
  • round_robin
  • session_hash

timeout_config

TimeoutConfig object

Configurações de tempo limite

web_tag

String

Nome do site

flag

Flag object

Identificador especial, que é usado no console.

description

String

Observações do site

http2_enable

Boolean

Suportar ou não HTTP/2.

  • true: HTTP/2 é suportado.
  • false: HTTP/2 não é suportado.

exclusive_ip

Boolean

Se usar um endereço IP dedicado.

  • true: Use um endereço IP dedicado.
  • false: Não use um endereço IP dedicado.

access_progress

Array of Access_progress objects

Progresso do acesso, que é usado apenas para o novo console do WAF.

Tabela 5 CloudWafServer

Parâmetro

Tipo

Descrição

front_protocol

String

Protocolo usado pelo cliente para solicitar acesso ao servidor de origem.

Valores de enumeração:

  • HTTP
  • HTTPS

back_protocol

String

Protocolo usado pelo WAF para encaminhar solicitações de clientes recebidas aos servidores de origem

Valores de enumeração:

  • HTTP
  • HTTPS

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

Formato de endereço IP do servidor de origem, IPv4 e IPv6

Valores de enumeração:

  • ipv4
  • ipv6
Tabela 6 BlockPage

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

Tabela 7 CustomPage

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).

Tabela 8 TrafficMark

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.

Tabela 9 CircuitBreaker

Parâmetro

Tipo

Descrição

switch

Boolean

Se deve ativar a proteção de conexão.

  • true: Ative a proteção de conexão.
  • false: Desative a proteção de conexão.

dead_num

Integer

Limite de erro 502/504. 502/504 erros permitidos a cada 30 segundos.

dead_ratio

Number

Uma proteção contra avarias é acionada quando o limite de erro 502/504 e o limite percentual foram atingidos.

block_time

Integer

Período de proteção após a primeira quebra. Durante esse período, o WAF deixa de encaminhar solicitações de clientes.

superposition_num

Integer

O multiplicador máximo que você pode usar para quebras consecutivas. O número de avarias é contado a partir de 0 sempre que a duração da proteção contra avarias acumulada atinge 3.600s. Por exemplo, suponha que o Tempo de Inatividade Inicial (s) esteja definido como 180s e Multiplier for Consecutive Breakdowns esteja definido como 3. Se a avaria for acionada pela segunda vez, ou seja, menos de 3, a duração da proteção é de 360s (180s X 2). Se a avaria for acionada pelo terceiro ou quarto tempo, ou seja, igual ou superior a 3, a duração da proteção é de 540s (180s X 3). Quando a duração do tempo de inatividade acumulado excede 1 hora (3.600s), o número de avarias é contado a partir de 0.

suspend_num

Integer

Limite do número de solicitações de URL pendentes. A proteção de conexão é acionada quando o limite é atingido.

sus_block_time

Integer

Duração do tempo de inatividade após a proteção da conexão ser acionada. Durante esse período, o WAF deixa de encaminhar solicitações de sites.

Tabela 10 TimeoutConfig

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.

Tabela 11 Bandeira

Parâmetro

Tipo

Descrição

pci_3ds

String

Se o site passa a verificação de certificação PCI 3DS.

  • true: O site passou na verificação de certificação PCI 3DS.
  • false: O site falhou na verificação de certificação do PCI 3DS.

Valores de enumeração:

  • true
  • false

pci_dss

String

Se o site passou na verificação de certificação PCI DSS.

  • true: O site passou na verificação de certificação PCI DSS.
  • false: O site falhou na verificação de certificação PCI DSS.

Valores de enumeração:

  • true
  • false

cname

String

O registro CNAME que está sendo usado.

  • old: O registro CNAME antigo é usado.
  • new: O novo registro CNAME é usado.

Valores de enumeração:

  • old
  • new

is_dual_az

String

Se o WAF suporta o Multi-AZ DR

  • true: O WAF suporta DR multi-AZ.
  • false: O WAF não suporta DR multi-AZ.

Valores de enumeração:

  • true
  • false

ipv6

String

Se a proteção IPv6 é suportada.

  • true: A proteção IPv6 é suportada.
  • false: A proteção IPv6 não é suportada.

Valores de enumeração:

  • true
  • false
Tabela 12 Access_progress

Parâmetro

Tipo

Descrição

step

Integer

Etapa

status

Integer

Estado. O valor pode ser 0 ou 1.

  • 0: O passo não foi concluído.
  • 1: O passo terminou.

Código de estado: 400

Tabela 13 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 14 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 15 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/instance/{instance_id}?enterprise_project_id=0

Exemplo de respostas

Código de estado: 200

OK

{
  "id" : "31af669f567246c289771694f2112289",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650527546420,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "ipv6" : "false",
    "cname" : "new",
    "is_dual_az" : "true"
  },
  "description" : "",
  "policyid" : "41cba8aee2e94bcdbf57460874205494",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "projectid" : "0456cf04d6f64725ab02ed5bd2efdfa4",
  "enterprise_project_id" : "0",
  "protect_status" : 0,
  "access_status" : 0,
  "access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
  "block_page" : {
    "template" : "default"
  },
  "web_tag" : "",
  "exclusive_ip" : false,
  "http2_enable" : false
}

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.