Parâmetros comuns - Web Application Firewall: Central de Documentação do Alibaba Cloud

Todas as solicitações e respostas da API do WAF compartilham um conjunto de parâmetros comuns. Este tópico descreve esses parâmetros e apresenta a estrutura correta de uma solicitação e de uma resposta.

Parâmetros comuns de solicitação

Inclua os seguintes parâmetros em todas as solicitações de API.

Parâmetro	Tipo	Obrigatório	Descrição
Format	String	Não	Formato da resposta. Valores válidos: JSON, XML. Padrão: XML.
Version	String	Sim	Versão da API no formato AAAA-MM-DD. Defina como `2019-09-10`.
AccessKeyId	String	Sim	Seu AccessKey ID.
Signature	String	Sim	String de assinatura da solicitação atual.
SignatureMethod	String	Sim	Algoritmo de assinatura. Defina como `HMAC-SHA1`.
Timestamp	String	Sim	Carimbo de data/hora da solicitação no formato ISO 8601: `AAAA-MM-DDThh:mm:ssZ` (UTC). Exemplo: `2013-01-10T12:00:00Z` representa 10 de janeiro de 2013, 20:00:00 UTC+8.
SignatureVersion	String	Sim	Versão do algoritmo de assinatura. Defina como `1.0`.
SignatureNonce	String	Sim	String aleatória única que impede ataques de replay. Use um valor diferente para cada solicitação.
ResourceOwnerAccount	String	Não	Conta Alibaba Cloud proprietária do recurso a ser acessado.

Exemplo de solicitação

https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&Region=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&Timestamp=2013-01-10T12:00:00Z
&Format=xml
&AccessKeyId=********
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2019-09-10
&SignatureVersion=1.0
&Signature=Signature

Parâmetros comuns de resposta

As respostas da API do WAF seguem as convenções padrão HTTP:

2xx: a chamada foi bem-sucedida.
4xx ou 5xx: a chamada falhou.

Toda resposta inclui um RequestId, independentemente do sucesso da chamada. As respostas são retornadas no formato JSON ou XML. O formato padrão é XML; para alterá-lo, defina o parâmetro de solicitação Format.

Exemplos de resposta

Formato XML

<?xml version="1.0" encoding="utf-8"?>
<!--Result root node-->
<InterfaceNameResponse>
    <!--Request tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Return result data-->
</InterfaceNameResponse>

Formato JSON

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /*Return result data*/
}