Tous les produits
Search

Ce produit

    IoT Platform:UpdateSubscribeRelation

    Centre de documentation

    IoT Platform:UpdateSubscribeRelation

    Dernière mise à jour :Aug 09, 2026

    Modifie un abonnement côté serveur Message Service (MNS) ou AMQP.

    Limites

    Chaque compte Alibaba Cloud peut effectuer au maximum 5 requêtes par seconde (QPS).

    Remarque

    Les utilisateurs RAM d’un compte Alibaba Cloud partagent le quota de ce compte.

    Débogage

    OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d’appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

    Paramètres de la requête

    ParameterTypeRequiredExampleDescription
    ActionStringYesUpdateSubscribeRelation

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

    ProductKeyStringYesa1fyXVF****

    ProductKey du produit spécifié pour l’abonnement.

    TypeStringYesAMQP

    Type d’abonnement. Valeurs valides :

    • MNS
    • AMQP
    IotInstanceIdStringNoiot-cn-0pp1n8t****

    ID de l’instance. Vous pouvez consulter l’ID de l’instance sur la page Overview de la console IoT Platform.

    Important
    • Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l’appel échoue.
    • Si votre instance ne dispose pas de page Overview ni d’ID, il n’est pas nécessaire de définir ce paramètre.

    Pour plus d’informations, consultez Overview.

    DeviceDataFlagBooleanNotrue

    Indique s’il faut pousser les messages des appareils en amont. Valeurs valides :

    • true : oui.
    • false : non.

    Valeur par défaut : false.

    DeviceStatusChangeFlagBooleanNotrue

    Indique s’il faut pousser les messages relatifs aux changements d’état des appareils. Valeurs valides :

    • true : oui.
    • false : non.

    Valeur par défaut : false.

    FoundDeviceListFlagBooleanNotrue

    Indique s’il faut pousser les messages lorsqu’une passerelle détecte de nouveaux sous-appareils. Valeurs valides :

    • true : oui. Ce paramètre s’applique uniquement aux produits de type passerelle.
    • false : non.

    Valeur par défaut : false.

    DeviceTopoLifeCycleFlagBooleanNotrue

    Indique s’il faut pousser les messages relatifs aux modifications des relations topologiques des appareils. Valeurs valides :

    • true : oui. Ce paramètre s’applique uniquement aux produits de type passerelle.
    • false : non.

    Valeur par défaut : false.

    DeviceLifeCycleFlagBooleanNotrue

    Indique s’il faut pousser les messages relatifs aux modifications du cycle de vie des appareils. Valeurs valides :

    • true : oui.
    • false : non.

    Valeur par défaut : false.

    ThingHistoryFlagBooleanNotrue

    Indique s’il faut pousser les données historiques Thing Specification Language (TSL) en amont. Valeurs valides :

    • true : oui.
    • false : non.

    Valeur par défaut : false.

    OtaEventFlagBooleanNotrue

    Indique s’il faut pousser les notifications relatives à l’état des lots de mise à jour OTA. Valeurs valides :

    • true : oui.
    • false : non.

    Valeur par défaut : false.

    DeviceTagFlagBooleanNotrue

    Indique s’il faut pousser les messages relatifs aux modifications des tags des appareils. Valeurs valides :

    • true : oui. Ce paramètre prend effet uniquement si le paramètre Type est défini sur AMQP.
    • false : non.

    Valeur par défaut : false.

    OtaVersionFlagBooleanNotrue

    Indique s’il faut pousser les messages relatifs aux numéros de version des modules OTA. Valeurs valides :

    • true : oui. Ce paramètre prend effet uniquement si le paramètre Type est défini sur AMQP.
    • false : non.

    Valeur par défaut : false.

    OtaJobFlagBooleanNotrue

    Indique s’il faut pousser les notifications relatives aux états des tâches de mise à jour OTA. Valeurs valides :

    • true : oui. Ce paramètre prend effet uniquement si le paramètre Type est défini sur AMQP.
    • false : non.

    Valeur par défaut : false.

    MnsConfigurationStringNo{ "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } }

    Configuration de la file d’attente MNS. Ce paramètre est requis si le paramètre Type est défini sur MNS.

    Pour plus d’informations, consultez la section « Définition du paramètre MnsConfiguration ».

    ConsumerGroupIds.NRepeatListNonJRaJPn5U1JITGfjBO9l00****

    ID des groupes de consommateurs créés dans l’abonnement AMQP. Ce paramètre est requis si le paramètre Type est défini sur AMQP.

    Après avoir appelé l’opération CreateConsumerGroup pour créer un groupe de consommateurs, l’ID du groupe est renvoyé. Vous pouvez appeler l’opération QueryConsumerGroupList pour récupérer l’ID du groupe de consommateurs par son nom. Vous pouvez également accéder à la console IoT Platform,puis choisir Rules > Server-side Subscription > Consumer Groups pour afficher l’ID du groupe de consommateurs.

    Remarque

    Vous devez définir au moins un paramètre lié à Flag sur

    true

    .

    Définition du paramètre MnsConfiguration

    Parameter

    Description

    queueName

    Nom du topic MNS utilisé pour recevoir les données. Vous devez créer une file d’attente dans la console MNS et obtenir son nom. Pour plus d’informations, consultez Créer une file d’attente.

    regionName

    Code de la région où MNS est déployé. Exemple : cn-shanghai.

    role

    Informations sur le rôle RAM. Pour accorder à IoT Platform l’accès à MNS, vous pouvez attribuer un rôle RAM à IoT Platform. Le script suivant illustre la syntaxe d’un rôle RAM :

    {"roleArn":"acs:ram::5645***:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}

    Remplacez 6541*** par votre ID Alibaba Cloud. Connectez-vous à la console Alibaba Cloud et consultez l’ID du compte sur la page Security Settings.

    AliyunIOTAccessingMNSRole est un rôle de service défini dans la console RAM. Ce rôle permet d’accorder à IoT Platform l’accès à MNS. Accédez à la page RAM Roles de la console RAM pour gérer les rôles RAM.

    Exemple du paramètre MnsConfiguration

    
{
    "queueName": "mns-test-topic1",
    "regionName": "cn-shanghai",
    "role": {
        "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole",
        "roleName": "AliyunIOTAccessingMNSRole"
    }
}

    Outre les paramètres de requête spécifiques à l’opération mentionnés précédemment, vous devez spécifier des paramètres de requête communs lors de l’appel à cette opération. Pour plus d’informations, consultez Paramètres de requête communs.

    Paramètres de réponse

    ParameterTypeExampleDescription
    CodeStringiot.system.SystemException

    Code d’erreur renvoyé en cas d’échec de l’appel. Pour plus d’informations, consultez Codes d’erreur.

    ErrorMessageStringA system exception occurred.

    Message d’erreur renvoyé en cas d’échec de l’appel.

    RequestIdString21D327AF-A7DE-4E59-B5D1-ACAC8C024555

    ID de la requête.

    SuccessBooleantrue

    Indique si l’appel a réussi.

    • true : L’appel a réussi.
    • false : L’appel a échoué.

    Exemples

    Exemples de requêtes

    https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateSubscribeRelation
&OtaEventFlag=true
&ProductKey=a1Zkii7****
&Type=AMQP
&ConsumerGroupIds.1=Xs95KifeaSKbi8tKkcoD00****
&<Common request parameters>

    Exemples de réponses réussies

    XML format

    <UpdateSubscribeRelationResponse>
        <RequestId>C21DA94F-07D7-482F-8A0C-5BB0E3CC1A82</RequestId>
        <Success>true</Success>
</UpdateSubscribeRelationResponse>

    JSON format

    {
    "RequestId": "C21DA94F-07D7-482F-8A0C-5BB0E3CC1A82",
    "Success": true
}

    Codes d’erreur

    Pour obtenir la liste des codes d’erreur, visitez le Centre d’erreurs API.