Tous les produits
Search

Ce produit

    IoT Platform:CreateOTAFirmware

    Centre de documentation

    IoT Platform:CreateOTAFirmware

    Dernière mise à jour :Aug 09, 2026

    Crée un package de mise à jour over-the-air (OTA) pour les appareils.

    Notes d'utilisation

    Avant d'appeler cette opération, appelez l'opération GenerateOTAUploadURL pour générer les informations de téléchargement, puis appelez l'opération PostObject d'Object Storage Service (OSS) pour télécharger les fichiers.

    Limites

    Vous pouvez créer au maximum 500 packages de mise à jour par instance.

    Limites QPS

    Chaque compte peut appeler cette opération jusqu'à 10 fois par seconde.

    Remarque

    Les utilisateurs Resource Access Management (RAM) d'un compte Alibaba Cloud partagent le quota de ce compte.

    Débogage

    OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

    Paramètres de requête

    Paramètre

    Type

    Obligatoire

    Exemple

    Description

    Action

    String

    Oui

    CreateOTAFirmware

    Opération à effectuer. Définissez la valeur sur CreateOTAFirmware.

    DestVersion

    String

    Oui

    2.0.0

    Numéro de version du package de mise à jour OTA. Caractères autorisés : lettres, chiffres, points (.), traits d'union (-) et underscores (_). Longueur : 1 à 64 caractères.

    FirmwareName

    String

    Oui

    Firmware2

    Nom du package de mise à jour OTA. Le nom doit être unique au sein d'un compte Alibaba Cloud et ne peut pas être modifié après la création du package. Longueur : 1 à 40 caractères. Caractères autorisés : lettres, chiffres, traits d'union (-), underscores (_) et parenthèses (). Doit commencer par une lettre ou un chiffre.

    IotInstanceId

    String

    Non

    iot-cn-0pp1n8t****

    ID de l'instance. Vous pouvez afficher l'ID de l'instance sur la page Overview de la console IoT Platform.

    Important

    • Si votre instance possède un ID, vous devez spécifier ce paramètre. Sinon, la requête échoue.

    • Si la page Overview ou l'ID de l'instance n'est pas affichée dans la console IoT Platform, vous n'avez pas besoin de spécifier ce paramètre.

    FirmwareUrl

    String

    Non

    https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/bcd6142594d0183a16d825ad8225**/A6B3400B70CA4D6D872160D1A91A**.bin

    URL du fichier à ajouter au package de mise à jour OTA. L'URL spécifie l'emplacement de stockage du fichier dans OSS. Appelez l'opération GenerateOTAUploadURL pour générer cette URL.

    Important

    Si vous souhaitez ajouter un seul fichier au package de mise à jour OTA, vous devez spécifier ce paramètre.

    FirmwareSign

    String

    Non

    93230c3bde425a9d7984a594ac55****

    Valeur de signature du fichier à ajouter au package de mise à jour OTA. La valeur est calculée à l'aide d'un algorithme de signature, tel que Secure Hash Algorithm 256 (SHA-256) ou MD5.

    Important

    Si vous souhaitez ajouter un seul fichier au package de mise à jour OTA, vous pouvez spécifier ce paramètre. Si vous ne le spécifiez pas, la valeur MD5 du fichier dans OSS est utilisée.

    SignMethod

    String

    Non

    MD5

    Algorithme de signature utilisé pour signer le fichier. Valeurs valides :

    • MD5 (par défaut)

    • SHA256

    FirmwareSize

    Integer

    Non

    900

    Taille du fichier à ajouter au package de mise à jour OTA. Unité : octets.

    Important

    Si vous souhaitez ajouter un seul fichier au package de mise à jour OTA, vous pouvez spécifier ce paramètre. Si vous ne le spécifiez pas, la taille du fichier dans OSS est utilisée.

    ProductKey

    String

    Non

    a1uctKe****

    ProductKey du produit auquel appartient le package de mise à jour OTA.

    FirmwareDesc

    String

    Non

    OTA function updated

    Description du package de mise à jour OTA. La description peut comporter jusqu'à 100 caractères.

    Type

    Integer

    Non

    0

    Type du package de mise à jour OTA. Valeurs valides :

    • 0 : Le fichier téléchargé contient un package de mise à jour complet. IoT Platform pousse le package de mise à jour complet vers un appareil pour la mise à jour.

    • 1 : Le fichier téléchargé contient uniquement les différences entre le dernier package de mise à jour et le package de mise à jour précédent. IoT Platform pousse uniquement les différences vers un appareil pour la mise à jour.

    Valeur par défaut : 0.

    SrcVersion

    String

    Non

    1.0.0

    Numéro de version du module OTA de l'appareil à mettre à jour.

    Appelez l'opération QueryDeviceDetail et consultez la valeur de FirmwareVersion dans la réponse.

    Remarque

    • Si vous définissez Type sur 1, vous devez spécifier ce paramètre, et sa valeur ne peut pas être identique à celle de DestVersion.

    • Si vous définissez Type sur 0, vous n'avez pas besoin de spécifier ce paramètre.

    ModuleName

    String

    Non

    WifiConfigModify

    Nom du module OTA. Les modules OTA sont les unités mises à jour des appareils appartenant au même produit.

    Remarque

    • Si vous ne spécifiez pas ce paramètre, le module OTA par défaut est utilisé. La valeur par défaut indique que le firmware complet de l'appareil est mis à jour.

    • Appelez l'opération CreateOTAModule pour créer un module OTA personnalisé. Appelez l'opération ListOTAModuleByProduct pour interroger les modules OTA existants d'un produit.

    NeedToVerify

    Boolean

    Non

    true

    Indique s'il faut vérifier le package de mise à jour OTA avant de créer une tâche de mise à jour par lot. Valeurs valides :

    • true (par défaut)

    • false

    Udi

    String

    Non

    {"ota_notice":"Update the underlying camera driver to resolve the issue of blurry images in videos."}

    Informations personnalisées à envoyer à un appareil. Le format n'est pas limité, mais le contenu ne peut pas dépasser 4 096 caractères.

    Après avoir créé le package de mise à jour OTA et une tâche de mise à jour, IoT Platform envoie ces informations personnalisées à l'appareil spécifié avec la notification de mise à jour.

    MultiFiles.N.Name

    String

    Non

    Firmware1

    Nom du fichier à ajouter au package de mise à jour OTA. Longueur : 1 à 32 caractères. Vous pouvez spécifier jusqu'à 20 noms de fichiers. Chaque nom doit être unique dans le package de mise à jour.

    Important

    Si vous souhaitez ajouter plusieurs fichiers au package de mise à jour OTA, vous devez spécifier ce paramètre.

    MultiFiles.N.Size

    Integer

    Non

    200

    Taille du fichier à ajouter au package de mise à jour OTA. Unité : octets.

    Remarque

    Si vous souhaitez ajouter plusieurs fichiers au package de mise à jour OTA, vous pouvez spécifier ce paramètre. Si vous ne le spécifiez pas, la taille du fichier dans OSS est utilisée.

    MultiFiles.N.Url

    String

    Non

    https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/bcd6142594d0183a16d825ad8225**/A6B3400B70CA4D6D872160D1A91A**.bin

    URL du fichier à ajouter au package de mise à jour OTA. L'URL spécifie l'emplacement de stockage du fichier dans OSS. Appelez l'opération GenerateOTAUploadURL pour générer une URL pour chaque fichier.

    Important

    Si vous souhaitez ajouter plusieurs fichiers au package de mise à jour OTA, vous devez spécifier ce paramètre.

    MultiFiles.N.SignValue

    String

    Non

    93230c3bde425a9d7984a594ac45****

    Valeur de signature du fichier à ajouter au package de mise à jour OTA. La valeur est calculée à l'aide d'un algorithme de signature.

    Remarque

    Si vous souhaitez ajouter plusieurs fichiers au package de mise à jour OTA, vous pouvez spécifier ce paramètre. Si vous ne le spécifiez pas, la valeur MD5 du fichier dans OSS est utilisée.

    MultiFiles.N.FileMd5

    String

    Non

    93230c3bde425a9d7984a594ac56***

    Valeur MD5 du fichier à ajouter au package de mise à jour OTA.

    Remarque

    Si vous souhaitez ajouter plusieurs fichiers au package de mise à jour OTA, vous pouvez spécifier ce paramètre. Si vous ne le spécifiez pas, la valeur MD5 du fichier dans OSS est utilisée.

    En plus des paramètres de requête spécifiques à l'opération listés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Common parameters.

    Paramètres de réponse

    Paramètre

    Type

    Exemple

    Description

    Code

    String

    iot.system.SystemException

    Code d'erreur renvoyé si la requête a échoué. Pour plus d'informations, consultez Codes d'erreur.

    Data

    Struct

    Informations du package de mise à jour OTA renvoyées si la requête a réussi.

    FirmwareId

    String

    s8SSHiKjpBfrM3BSN0z803****

    ID unique du package de mise à jour OTA, émis par IoT Platform.

    UtcCreate

    String

    2019-11-04T06:21:54.607Z

    Heure de création du package de mise à jour OTA, au format UTC.

    ErrorMessage

    String

    A system exception occurred.

    Message d'erreur renvoyé si la requête a échoué.

    RequestId

    String

    291438BA-6E10-4C4C-B761-243B9A0D324F

    ID de la requête.

    Success

    Boolean

    true

    Indique si la requête a réussi. Valeurs valides :

    • true

    • false

    Exemples

    Exemples de requêtes

    https://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAFirmware
&ProductKey=a1uctKe****
&FirmwareName=Firmware2
&DestVersion=2.0.0
&FirmwareUrl=https%3A%2F%2iotx-ota.oss-cn-shanghai.aliyuncs.com%2Fota%2F****%2F****.bin
&SignMethod=MD5
&FirmwareSign=93230c3bde425a9d7984a594ac55****
&FirmwareSize=900
&FirmwareDesc=OTA function updated
&Type=0
&ModuleName=WifiConfigModify
&<Common request parameters>

    Exemples de réponses réussies

    Format XML

    <CreateOTAFirmwareResponse>
    <Data>
        <FirmwareId>s8SSHiKjpBfrM3BSN0z803****</FirmwareId>
        <UtcCreate>2019-11-04T06:21:54.607Z</UtcCreate>
    </Data>
    <RequestId>E4BD5A12-7C1D-4712-A7D5-B2432331165E</RequestId>
    <Success>true</Success>
</CreateOTAFirmwareResponse>

    Format JSON

    {  
  "Data": {
    "FirmwareId": "s8SSHiKjpBfrM3BSN0z803****",
    "UtcCreate": "2019-11-04T06:21:54.607Z"
  },
  "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
  "Success": true
}

    Codes d'erreur

    Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.