Consulta de um nome de domínio por ID
Função
Essa API é usada para consultar um nome de domínio protegido por ID.
URI
GET /v1/{project_id}/composite-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. No modo nuvem, ele pode ser obtido chamando a API ListHost. No modo dedicado, ele pode ser obtido chamando a API ListPremiumHost. |
|
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âmetros de resposta
Código de estado: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
|
|
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.
|
|
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.
|
|
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.
|
|
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. |
|
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 |
|---|---|---|
|
step |
Integer |
Etapa |
|
status |
Integer |
Estado. O valor pode ser 0 ou 1.
|
|
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.
|
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}/composite-waf/host/{host_id}?enterprise_project_id=0
Exemplo de respostas
Código de estado: 200
OK
{
"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"
}
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.