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/ Consulta de nome de domínio de um inquilino/ Consulta de nomes de domínio protegidos com todas as instâncias do WAF

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

Ver PDF

Consulta de nomes de domínio protegidos com todas as instâncias do WAF

Função

Essa API é usada para consultar a lista de nomes de domínio de proteção.

URI

GET /v1/{project_id}/composite-waf/host

**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
hostname	Não	String	Nome de domínio
policyname	Não	String	Nome da política
protect_status	Não	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.
waf_type	Não	String	Modo WAF do nome de domínio
is_https	Não	Boolean	Se HTTPS é usado para o nome de domínio

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 de todos os nomes de domínio protegidos
cloud_total	Integer	Número de nomes de domínio protegidos com o WAF na nuvem
premium_total	Integer	Número de nomes de domínio protegidos com instâncias WAF dedicadas
items	Array of CompositeHostResponse objects	Detalhes sobre o nome de domínio protegido

**Tabela 5** CompositeHostResponse
Parâmetro	Tipo	Descrição
id	String	false: O endereço IP exclusivo não é prático.
hostid	String	ID do nome de domínio
hostname	String	Nome de domínio adicionado ao WAF na nuvem.
policyid	String	ID da política
access_code	String	Prefixo CNAME
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.
proxy	Boolean	Se um proxy é usado para o nome de domínio protegido. false: Nenhum proxy é usado. true: Um proxy é usado.
timestamp	Long	Hora em que o nome de domínio foi adicionado ao WAF.
paid_type	String	Modo de pagamento baseado em pacote. Atualmente, apenas o modo pré-pago é suportado.
flag	Flag object	Identificador especial, que é usado no console.
waf_type	String	Modo de WAF usado para proteger o nome de domínio. O valor pode ser cloud ou premium. cloud: O WAF na nuvem é usado para proteger o domínio. premium: Uma instância dedicada do WAF é usada para proteger o nome de domínio.
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.
access_progress	Array of Access_progress objects	Progresso do acesso, que é usado apenas para o novo console do WAF.
premium_waf_instances	Array of Premium_waf_instances objects	Lista de instâncias WAF dedicadas
description	String	Descrição do nome de domínio
exclusive_ip	Boolean	Se usar um endereço IP exclusivo. true: O endereço IP exclusivo é usado. false: O endereço IP exclusivo não é prático.
region	String	ID da região. Esse parâmetro é incluído quando o nome de domínio é adicionado ao WAF por meio do console. Esse parâmetro é deixado em branco quando o nome de domínio é adicionado ao WAF ao chamar uma API. Você pode consultar o ID da região na página Regiões e Endpoints no site da Huawei Cloud.

**Tabela 6** 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 7** 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.

**Tabela 8** Premium_waf_instances
Parâmetro	Tipo	Descrição
id	String	ID da instância dedicada do WAF
name	String	Nome da instância dedicada do WAF
accessed	Boolean	Se o nome de domínio é adicionado à instância dedicada do WAF. As opções são true e false. true: O nome de domínio foi adicionado ao WAF. false: O nome de domínio não foi adicionado ao WAF.

Código de estado: 400

**Tabela 9** 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 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: 500

**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

Exemplos de solicitações

GET https://{Endpoint}/v1/{project_id}/composite-waf/host?enterprise_project_id=0

Exemplo de respostas

Código de estado: 200

{
  "items" : [ {
    "id" : "31af669f567246c289771694f2112289",
    "hostid" : "31af669f567246c289771694f2112289",
    "description" : "",
    "proxy" : false,
    "flag" : {
      "pci_3ds" : "false",
      "pci_dss" : "false",
      "ipv6" : "false",
      "cname" : "new",
      "is_dual_az" : "true"
    },
    "region" : "cn-north-4",
    "hostname" : "www.demo.com",
    "access_code" : "1b18879b9d064f8bbcbf8abce7294cac",
    "policyid" : "41cba8aee2e94bcdbf57460874205494",
    "timestamp" : 1650527546454,
    "protect_status" : 0,
    "access_status" : 0,
    "exclusive_ip" : false,
    "web_tag" : "",
    "paid_type" : "prePaid",
    "waf_type" : "cloud"
  } ],
  "total" : 1,
  "cloud_total" : 1,
  "premium_total" : 0
}