Parámetros comunes - IoT Platform - Centro de documentación de Alibaba Cloud

Este tema describe los parámetros de solicitud y respuesta comunes de las API de IoT Platform.

Parámetros de solicitud comunes

Todas las solicitudes a la API de IoT Platform deben incluir los parámetros de solicitud comunes.

Parámetro	Tipo	Obligatorio	Descripción
Format	String	No.	Formato de la respuesta. Valores válidos: JSON y XML. Valor predeterminado: XML.
Version	String	Sí	Número de versión de la API. El valor tiene el formato `YYYY-MM-DD`. Valores válidos: `2018-01-20`.
AccessKeyId	String	Sí	AccessKey ID proporcionado por Alibaba Cloud. Para crear o consultar un par de AccessKey, siga estos pasos: inicie sesión en la Alibaba Cloud Management Console, pase el puntero sobre la foto de perfil y haga clic en AccessKey Management. En la página AccessKey Pair, consulte o cree un par de AccessKey.
Signature	String	Sí	Cadena de firma de la solicitud actual. Para obtener más información sobre cómo se calculan las firmas, consulte Signature method.
SignatureMethod	String	Sí	Método de cifrado de la cadena de firma. Establezca el valor en HMAC-SHA1.
Timestamp	String	Sí	Marca de tiempo de la solicitud. Especifique la hora según el estándar ISO 8601 en formato UTC: `YYYY-MM-DDThh:mm:ssZ`. Por ejemplo, establezca este parámetro en `2016-01-04T12:00:00Z`, que corresponde al 4 de enero de 2016 a las 20:00:00 UTC+8.
SignatureVersion	String	Sí	Número de versión del algoritmo de cifrado de la firma. Establezca el valor en 1.0.
SignatureNonce	String	Sí	Número aleatorio único para evitar ataques de reproducción. Use un número diferente en cada solicitud.
RegionId	String	Sí	ID de la región donde residen sus dispositivos. La región debe coincidir con la especificada en la consola de IoT Platform. Ejemplo: cn-shanghai. Para obtener más información sobre los ID de las regiones compatibles con IoT Platform, consulte Supported regions.

Ejemplo:

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 respuesta comunes

Las respuestas de la API siguen el formato HTTP: un código de estado 2xx indica una llamada exitosa, mientras que 4xx o 5xx señala un error. Las respuestas pueden devolverse en formato JSON o XML; especifique el formato deseado en la solicitud. El formato predeterminado es XML.

Cada respuesta incluye un ID de solicitud único indicado por el parámetro RequestId, sin importar si la llamada fue exitosa.

Ejemplos de respuestas exitosas

Formato XML

API de IoT Platform versión 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 */
}

Ejemplos de respuestas con errores

Si ocurre un error al llamar a una operación de la API, no se devuelven datos de resultado. Utilice el código de error para identificar la causa.

Si ocurre un error al llamar a una operación de la API, se devuelve un código de estado HTTP 4XX o 5XX. El mensaje contiene el código y la descripción del error, además de un ID de solicitud globalmente único en el parámetro RequestId. Si no logra determinar la causa del error, póngase en contacto con el servicio de atención al cliente de Alibaba Cloud o envíe un ticket; proporcione su ID de solicitud para recibir asistencia.
- 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."
}
```