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

Este tópico descreve os parâmetros comuns a todas as solicitações e respostas de API do Message Queue for MQTT.

Parâmetros comuns de solicitação

Tabela 1. Parâmetros comuns de solicitação
Parâmetro	Tipo	Obrigatório	Descrição
Format	String	Não	Formato da resposta. Valores válidos: JSON XML
Version	String	Sim	Número da versão da API. Especifique o número da versão no formato AAAA-MM-DD. Valores válidos: 2020-04-20
AccessKeyId	String	Sim	AccessKey ID da sua conta Alibaba Cloud. Para obter um AccessKey ID, consulte Obter um par de AccessKey.
Signature	String	Sim	String de assinatura da solicitação atual. Para saber como calcular assinaturas, consulte Método de assinatura.
SignatureMethod	String	Sim	Método de criptografia da string de assinatura. Defina o valor como HMAC-SHA1
Timestamp	String	Sim	Carimbo de data/hora da solicitação. Especifique a hora no padrão ISO 8601, no formato AAAA-MM-DDThh:mm:ssZ. A hora deve estar em UTC. Por exemplo, use 2013-01-10T12:00:00Z para especificar 20:00:00 em 10 de janeiro de 2013 (UTC+8).
SignatureVersion	String	Sim	Versão do algoritmo de criptografia de assinatura. Defina o valor como 1,0
SignatureNonce	String	Sim	Número aleatório exclusivo usado para evitar ataques de repetição. Use um número aleatório exclusivo para cada solicitação.
ResourceOwnerAccount	String	Não	Conta Alibaba Cloud proprietária do recurso que você deseja acessar.

Exemplos de solicitações

http://onsmqtt.[regionId].aliyuncs.com/?Action=[ApiName]
&TimeStamp=2020-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE****
&Version=2020-04-20
&SignatureVersion=1.0
&Signature=[Signature]

Parâmetros comuns de resposta

As respostas da API utilizam o formato de resposta HTTP. A resposta pode ser retornada no formato JSON ou XML. É possível especificar o formato da resposta na solicitação. O formato de resposta padrão é XML. Toda resposta retorna um

RequestId

exclusivo, independentemente do sucesso da chamada.

Um código de status HTTP 2xx indica uma chamada bem-sucedida.
Um código de status HTTP 4xx ou 5xx indica falha na chamada.

Exemplos de respostas de sucesso

Cada resposta de sucesso retorna parâmetros de resposta e um ID de solicitação. Nessas respostas, o código de status HTTP é 2xx.

Formato XML

<?xml version="1.0" encoding="utf-8"?> 
    <!--Root node of the response-->
    <Operation name+Response>
        <!--Returned request tag-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--Returned data-->
    </Operation name+Response>

Formato JSON

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

Exemplos de respostas de erro

Se ocorrer um erro ao chamar uma operação, o sistema retornará uma resposta de erro composta por um código de erro, uma mensagem de erro e um ID de solicitação. Em respostas de erro, o código de status HTTP é 4xx ou 5xx. Solucione problemas com base nos códigos de erro. Para mais informações, consulte Códigos de erro. Caso não consiga resolver o problema pelos códigos de erro, entre em contato com o suporte técnico do ApsaraMQ for MQTT.

Formato XML

<?xml version="1.0" encoding="UTF-8"?><!--Root node of the response-->
<Error>
    <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--Request ID-->
    <Code>MissingParameter.CommandId</Code> <!--Error code-->
    <Message>The input parameter "CommandId" that is mandatory for processing this request is not supplied.</Message> <!--Error message-->
</Error>

Formato JSON

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* Request ID */
    "Code": "MissingParameter.CommandId", /* Error code */
    "Message": "The input parameter "CommandId" that is mandatory for processing this request is not supplied." /* Error message */
}