Consulta de nomes de domínio protegidos por mecanismos WAF dedicados
Função
Essa API é usada para consultar a lista de nomes de domínio conectados a instâncias dedicadas do WAF.
URI
GET /v1/{project_id}/premium-waf/host
| 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. |
| 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 | String | Número de página dos dados a serem retornados durante a consulta de paginação. Faixa de valor: 0 a 100.000. O valor padrão é 1, indicando que os dados na primeira página são retornados. Padrão: 1 |
| pagesize | Não | String | 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.
|
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 |
|---|---|---|
| total | Integer | Número total de nomes de domínio protegidos |
| items | Array of SimplePremiumWafHost objects | Matriz de detalhes sobre todos os nomes de domínio protegidos |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID do nome de domínio |
| hostname | String | Nome de domínio |
| extend | Map<String,String> | Campo estendido, que é usado para salvar algumas informações de configuração sobre o nome de domínio protegido. |
| 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. |
| 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 de uma política específica. |
| 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. |
| hostid | String | ID de nome de domínio, que é o mesmo que o valor de id e é um campo redundante. |
| 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:
|
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?enterprise_project_id=0 Exemplo de respostas
Código de estado: 200
OK
{
"total" : 1,
"items" : [ {
"id" : "ee896796e1a84f3f85865ae0853d8974",
"hostname" : "www.demo.com",
"extend" : { },
"region" : "cn-north-4",
"flag" : {
"pci_3ds" : "false",
"pci_dss" : "false"
},
"description" : "",
"policyid" : "df15d0eb84194950a8fdc615b6c012dc",
"protect_status" : 1,
"access_status" : 0,
"hostid" : "ee896796e1a84f3f85865ae0853d8974"
} ]
} 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.