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

Este tópico descreve os parâmetros de solicitação e de resposta comuns das APIs do IoT Platform.

Parâmetros de solicitação comuns

Inclua os parâmetros de solicitação comuns em todas as solicitações de API do IoT Platform.

Parâmetro	Tipo	Obrigatório	Descrição
Format	String	Não	Formato de retorno da resposta. Valores válidos: JSON e XML. Valor padrão: XML.
Version	String	Sim	Versão da API no formato `AAAA-MM-DD`. Valores válidos: `2018-01-20`.
AccessKeyId	String	Sim	AccessKey ID fornecido pelo Alibaba Cloud. Para criar ou visualizar um par de AccessKey, siga estas etapas: faça logon no Alibaba Cloud Management Console, passe o ponteiro sobre a foto do perfil e clique em AccessKey Management. Na página AccessKey Pair, visualize ou crie um par de AccessKey.
Signature	String	Sim	String de assinatura da solicitação atual. Para obter mais informações sobre o cálculo de 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, obrigatoriamente em UTC. Formato: `AAAA-MM-DDThh:mm:ssZ`. Por exemplo, defina este parâmetro como `2016-01-04T12:00:00Z`, que representa 4 de janeiro de 2016 às 20:00:00 UTC+8.
SignatureVersion	String	Sim	Versão do algoritmo de criptografia da assinatura. Defina o valor como 1,0.
SignatureNonce	String	Sim	Número aleatório exclusivo para evitar ataques de repetição. Use números diferentes para cada solicitação.
RegionId	String	Sim	ID da região onde os dispositivos estão localizados. A região deve ser igual à especificada no console do IoT Platform. Exemplo: cn-shanghai. Para obter mais informações sobre os IDs das regiões compatíveis com o IoT Platform, consulte Regiões compatíveis.

Exemplo:

https://iot.cn-shanghai.aliyuncs.com/
?Format=XML
&Version=2018-01-20
&Signature=Pc5WB***
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=234***
&Timestamp=2018-05-20T12:00:00Z
&RegionId=cn-shanghai

Parâmetros de resposta comuns

As respostas da API seguem o formato de resposta HTTP, em que um código de status 2xx indica sucesso e códigos 4xx ou 5xx indicam falha. As respostas podem ser retornadas nos formatos JSON ou XML. Especifique o formato desejado na solicitação. O formato padrão é XML.

Toda resposta inclui um ID de solicitação exclusivo, representado pelo parâmetro RequestId, independentemente do sucesso da chamada.

Exemplos de respostas de sucesso

Formato XML

API do IoT Platform versão 2018-01-20

<?xml version="1.0" encoding="UTF-8"?>
<!--Result root node-->
<Operation name + Response>
    <!--Return request tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Return result data-->
</API operation name+Response>

Formato JSON

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

Exemplos de respostas de erro

Se ocorrer um erro durante a chamada de uma operação de API, nenhum dado de resultado será retornado. Use o código de erro para identificar a causa do problema.

Em caso de erro na chamada da API, o sistema retorna um código de status HTTP 4XX ou 5XX. A mensagem de resposta contém o código e a descrição específicos do erro, além de um ID de solicitação globalmente exclusivo no parâmetro RequestId. Se não conseguir identificar a origem do erro, entre em contato com o suporte ao cliente do Alibaba Cloud ou abra um ticket. Forneça o ID da solicitação para receber assistência.
- Formato XML
```
<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported.</Message>
</Error>
```
- Formato JSON
```
{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}
```