Adiciona um nome de domínio a uma instância do Web Application Firewall (WAF).
Depuração
Parâmetros da solicitação
| Parâmetro | Tipo | Obrigatório | Exemplo | Descrição |
|---|---|---|---|---|
| Action | String | Sim | CreateDomain | A operação a ser executada. Defina o valor como CreateDomain. |
| InstanceId | String | Sim | waf-cn-7pp26f1**** | ID da instância do WAF. Para obter o ID da instância, chame a operação DescribeInstanceInfo. |
| Domain | String | Sim | www.example.com | Nome de domínio a adicionar ao WAF. |
| IsAccessProduct | Integer | Sim | 0 | Indica se há um proxy de camada 7 configurado antes do WAF. Os proxies de camada 7 incluem Anti-DDoS Pro, Anti-DDoS Premium e Alibaba Cloud CDN. Valores válidos: 0: nenhum proxy de camada 7 configurado. 1: proxy de camada 7 configurado. |
| AccessHeaderMode | Integer | Não | 0 | Método usado pelo WAF para obter o endereço IP real do cliente. Valores válidos: 0 (padrão): o WAF lê o primeiro valor do cabeçalho X-Forwarded-For (XFF). 1: o WAF lê um campo de cabeçalho personalizado. Importante Necessário apenas quando IsAccessProduct estiver definido como 1. |
| AccessHeaders | String | Não | ["X-Client-IP"] | Campos de cabeçalho personalizados usados pelo WAF para obter o endereço IP real do cliente. Formato: ["header1","header2",...]. Importante Necessário apenas quando AccessHeaderMode estiver definido como 1. |
| LogHeaders | String | Não | [{"k":"ALIWAF-TAG","v":"Yes"}] | Pares chave-valor usados para rotular solicitações que passam pela instância do WAF. Formato: [{"k":"_key_","v":"_value_"}]. O WAF adiciona esses pares aos cabeçalhos das solicitações para que o serviço de backend identifique as requisições protegidas. Se a solicitação já contiver o campo de cabeçalho personalizado, o WAF substituirá o valor original. |
| ResourceGroupId | String | Não | rg-atstuj3rtop**** | ID do grupo de recursos ao qual a instância do WAF pertence. Por padrão, a instância pertence ao grupo de recursos padrão. |
| AccessType | String | Não | waf-cloud-dns | Modo de adição do nome de domínio ao WAF. Valores válidos: waf-cloud-dns (padrão): modo de registro CNAME. waf-cloud-native: modo de proxy transparente. |
| HttpPort | String | Não | [80] | Portas HTTP. Formato: ["port1","port2",...]. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns. Indica que o site usa HTTP. Especifique HttpPort ou HttpsPort. |
| HttpsPort | String | Não | [443] | Portas HTTPS. Formato: ["port1","port2",...]. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns. Indica que o site usa HTTPS. Especifique HttpPort ou HttpsPort. |
| HttpsRedirect | Integer | Não | 0 | Define se o redirecionamento de HTTP para HTTPS deve ser ativado. Quando ativado, as solicitações são enviadas via HTTPS na porta 443. Valores válidos: 0 (padrão): desativado. 1: ativado. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns e HttpsPort for especificado. |
| Http2Port | String | Não | [443] | Portas HTTP/2. Formato: ["port1","port2",...]. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns e HttpsPort for especificado. |
| HttpToUserIp | Integer | Não | 0 | Especifica se o redirecionamento de HTTPS para HTTP deve ser ativado para solicitações de back-to-origin. Quando ativado, o WAF encaminha as requisições ao servidor de origem via HTTP na porta 80. Valores válidos: 0 (padrão): desativado. 1: ativado. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns e HttpsPort for especificado. |
| IpFollowStatus | Integer | Não | 1 | Determina se o WAF encaminha solicitações aos servidores de origem com base no tipo de endereço IP da requisição. Quando ativado, solicitações IPv4 são encaminhadas para servidores de origem IPv4 e solicitações IPv6 para servidores de origem IPv6. Valores válidos: 0: desativado. 1: ativado. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns. |
| SourceIps | String | Não | ["39.XX.XX.197"] | Endereço IP ou nome de domínio do servidor de origem. Especifique apenas um tipo. Formato de endereço IP: ["ip1","ip2",...]. Até 20 endereços IP. Formato de nome de domínio: ["domain"]. Apenas um nome de domínio. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns. |
| LoadBalancing | Integer | Não | 0 | Algoritmo de balanceamento de carga usado pelo WAF para encaminhar solicitações ao servidor de origem. Valores válidos: 0: algoritmo de hash de IP. 1: algoritmo round-robin. 2: algoritmo de menor tempo. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns. |
| ClusterType | Integer | Não | 0 | Tipo de cluster de proteção do WAF. Valores válidos: 0 (padrão): cluster compartilhado. 1: cluster exclusivo. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns. |
| ConnectionTime | Integer | Não | 5 | Tempo limite de conexão para clusters exclusivos do WAF. Unidade: segundos. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns e ClusterType estiver definido como 1. |
| ReadTime | Integer | Não | 120 | Tempo limite de conexão de leitura para clusters exclusivos do WAF. Unidade: segundos. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns e ClusterType estiver definido como 1. |
| WriteTime | Integer | Não | 120 | Tempo limite de conexão de gravação para clusters exclusivos do WAF. Unidade: segundos. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns e ClusterType estiver definido como 1. |
| CloudNativeInstances | String | Não | [{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}] | Configurações de servidor e porta para o modo de proxy transparente. Especifique como uma string de array JSON. Cada elemento contém os seguintes campos: ProtocolPortConfigs (obrigatório): configurações de protocolo e porta. Cada elemento contém: Ports (obrigatório): portas, no formato [port1,port2,...]. Protocol (obrigatório): protocolo. Valores válidos: http, https. CloudNativeProductName (obrigatório): tipo de instância do serviço em nuvem. Valores válidos: ECS, SLB, ALB. RedirectionTypeName (obrigatório): tipo de porta de redirecionamento de tráfego. Valores válidos: ECS, SLB-L4, SLB-L7, ALB. InstanceId (obrigatório): ID da instância do serviço em nuvem. IPAddressList (obrigatório): endereços IP públicos da instância do serviço em nuvem, no formato ["ip1","ip2",...]. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-native. |
| SniStatus | Integer | Não | 1 | Indica se o Server Name Indication (SNI) de origem deve ser ativado. O SNI de origem especifica o nome de domínio para handshakes HTTPS quando o WAF encaminha solicitações ao servidor de origem. Ative esta opção quando o servidor de origem hospedar vários nomes de domínio. Valores válidos: 0: desativado. 1: ativado. Por padrão, o SNI de origem é desativado para instâncias do WAF na China continental e ativado para instâncias fora da China continental. Importante Necessário apenas quando AccessType estiver definido como waf-cloud-dns e HttpsPort for especificado. |
| SniHost | String | Não | waf.example.com | Valor personalizado do campo SNI para solicitações de back-to-origin. Se não for especificado, o WAF usa o valor do cabeçalho Host. Especifique um valor personalizado quando o campo SNI precisar ser diferente do valor do cabeçalho Host. Importante Necessário apenas quando SniStatus estiver definido como 1. |
| Retry | Boolean | Não | true | Define se o WAF deve tentar reencaminhar solicitações em caso de falha no encaminhamento. Valores válidos: true (padrão), false. |
| Keepalive | Boolean | Não | true | Indica se conexões persistentes devem ser ativadas. Valores válidos: true (padrão), false. |
| KeepaliveRequests | Integer | Não | 1000 | Quantidade de conexões persistentes reutilizadas. Valores válidos: 60 a 1000. |
| KeepaliveTimeout | Integer | Não | 15 | Tempo limite de ociosidade para conexões persistentes. Unidade: segundos. Valores válidos: 1 a 60. Valor padrão: 15. |
Todas as solicitações de API do Alibaba Cloud devem incluir parâmetros de solicitação comuns. Para mais informações, consulte Parâmetros de solicitação comuns.
Elementos da resposta
|
Parâmetro |
Tipo |
Exemplo |
Descrição |
|
Cname |
String |
mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com |
CNAME atribuído pelo WAF ao nome de domínio. Retornado apenas quando AccessType estiver definido como waf-cloud-dns. |
|
RequestId |
String |
D7861F61-5B61-46CE-A47C-6B19160D5EB0 |
ID da solicitação. |
Exemplos
Exemplos de solicitações
http(s)://[Endpoint]/?Action=CreateDomain
&InstanceId=waf-cn-7pp26f1****
&Domain=www.example.com
&IsAccessProduct=0
&HttpPort=["80"]
&SourceIps=["39.XX.XX.197"]
&<Common request parameters>
Exemplos de respostas de sucesso
Formato XML
<CreateDomainResponse>
<Cname>mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com</Cname>
<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</CreateDomainResponse>
Formato JSON
{
"Cname": "mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com",
"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}
Códigos de erro
Para obter uma lista de códigos de erro, visite a Central de Erros de API.