すべてのプロダクト
Search

このプロダクト

    IoT Platform:UpdateSubscribeRelation

    ドキュメントセンター

    IoT Platform:UpdateSubscribeRelation

    最終更新日:Jun 25, 2025

    Message Service (MNS) または AMQP サーバー側サブスクリプションを変更します。

    制限

    各 Alibaba Cloud アカウントは、最大 5 クエリ/秒（QPS）を実行できます。

    説明

    Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

    デバッグ

    OpenAPI Explorer は、署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメーター

    タイプ

    必須

    例

    説明

    Action

    String

    Yes

    UpdateSubscribeRelation

    実行する操作。値を UpdateSubscribeRelation に設定します。

    ProductKey

    String

    Yes

    a1fyXVF****

    サブスクリプションに指定されたプロダクトの ProductKey。

    Type

    String

    Yes

    AMQP

    サブスクリプションのタイプ。有効な値：

    • MNS

    • AMQP

    IotInstanceId

    String

    No

    iot-cn-0pp1n8t****

    インスタンスの ID。IoT Platform コンソールの 概要 ページでインスタンス ID を表示できます。

    重要

    • インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。

    • インスタンスに 概要 ページまたは ID がない場合は、このパラメーターを設定する必要はありません。

    詳細については、「概要」をご参照ください。

    DeviceDataFlag

    Boolean

    No

    true

    上流デバイスメッセージをプッシュするかどうかを指定します。有効な値：

    • true: はい。

    • false: いいえ。

    デフォルト値: false。

    DeviceStatusChangeFlag

    Boolean

    No

    true

    デバイスのステータス変更に関するメッセージをプッシュするかどうかを指定します。有効な値：

    • true: はい。

    • false: いいえ。

    デフォルト値: false。

    FoundDeviceListFlag

    Boolean

    No

    true

    ゲートウェイが新しいサブデバイスを検出した場合にメッセージをプッシュするかどうかを指定します。有効な値：

    • true: はい。このパラメーターは、ゲートウェイ製品に対してのみ有効です。

    • false: いいえ。

    デフォルト値: false。

    DeviceTopoLifeCycleFlag

    Boolean

    No

    true

    デバイスのトポロジ関係の変更に関するメッセージをプッシュするかどうかを指定します。有効な値：

    • true: はい。このパラメーターは、ゲートウェイ製品に対してのみ有効です。

    • false: いいえ。

    デフォルト値: false。

    DeviceLifeCycleFlag

    Boolean

    No

    true

    デバイスのライフサイクル変更に関するメッセージをプッシュするかどうかを指定します。有効な値：

    • true: はい。

    • false: いいえ。

    デフォルト値: false。

    ThingHistoryFlag

    Boolean

    No

    true

    上流の履歴 Thing Specification Language（TSL）データをプッシュするかどうかを指定します。有効な値：

    • true: はい。

    • false: いいえ。

    デフォルト値: false。

    OtaEventFlag

    Boolean

    No

    true

    ファームウェアアップデートバッチのステータスに関する通知をプッシュするかどうかを指定します。有効な値：

    • true: はい。

    • false: いいえ。

    デフォルト値: false。

    DeviceTagFlag

    Boolean

    No

    true

    デバイスのトポロジ関係の変更に関するメッセージをプッシュするかどうかを指定します。有効な値：

    • true: はい。このパラメーターは、Type パラメーターが AMQP に設定されている場合にのみ有効になります。

    • false: いいえ。

    デフォルト値: false。

    OtaVersionFlag

    Boolean

    No

    true

    ファームウェアアップデートモジュールバージョン番号に関するメッセージをプッシュするかどうかを指定します。有効な値：

    • true: はい。このパラメーターは、Type パラメーターが AMQP に設定されている場合にのみ有効になります。

    • false: いいえ。

    デフォルト値: false。

    OtaJobFlag

    Boolean

    No

    true

    ファームウェアアップデートバッチのステータスに関する通知をプッシュするかどうかを指定します。有効な値：

    • true: はい。このパラメーターは、Type パラメーターが AMQP に設定されている場合にのみ有効になります。

    • false: いいえ。

    デフォルト値: false。

    MnsConfiguration

    String

    No

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

    MNS キューの構成。Type パラメーターが AMQP に設定されている場合、このパラメーターは必須です。

    詳細については、「MnsConfiguration パラメーターの定義」セクションをご参照ください。

    ConsumerGroupIds.N

    RepeatList

    No

    nJRaJPn5U1JITGfjBO9l00****

    AMQP サブスクリプションで作成されたコンシューマーグループの ID。Type パラメーターが AMQP に設定されている場合、このパラメーターは必須です。

    CreateConsumerGroup 操作を呼び出してコンシューマーグループを作成すると、コンシューマーグループ ID が返されます。QueryConsumerGroupList 操作を呼び出して、グループ名でコンシューマーグループ ID を照会できます。また、IoT Platform コンソールに移動し、ルール > サーバー側サブスクリプション > コンシューマーグループ を選択して、コンシューマーグループ ID を表示することもできます。

    説明

    Flag 関連パラメーターを少なくとも 1 つ true に設定する必要があります。

    MnsConfiguration パラメーターの定義

    パラメーター

    説明

    queueName

    データを受信するために使用される MNS Topic の名前。MNS コンソールでキューを作成し、キュー名を取得する必要があります。詳細については、「キューベースのメッセージングを開始する」をご参照ください。

    regionName

    MNS がデプロイされているリージョンのコード。例: cn-shanghai。

    role

    RAM ロールの情報。IoT Platform に MNS へのアクセス権を付与するには、IoT Platform に RAM ロールを割り当てることができます。次のスクリプトは、RAM ロールの構文を示しています。

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

    6541*** を Alibaba Cloud ID に置き換えます。Alibaba Cloud 管理コンソールにログインし、セキュリティ設定ページでアカウント ID を表示できます。

    AliyunIOTAccessingMNSRole は、RAM コンソールで指定されたサービロールです。このロールは、IoT Platform に MNS へのアクセス権を付与するために使用されます。RAM コンソールの RAM ロールページに移動して、RAM ロールを管理できます。

    MnsConfiguration パラメーターの例

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

    上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

    レスポンスパラメーター

    パラメーター

    タイプ

    例

    説明

    Code

    String

    iot.system.SystemException

    呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。

    ErrorMessage

    String

    システム例外が発生しました。

    呼び出しが失敗した場合に返されるエラーメッセージ。

    RequestId

    String

    21D327AF-A7DE-4E59-B5D1-ACAC8C024555

    リクエストの ID。

    Success

    Boolean

    true

    呼び出しが成功したかどうかを示します。

    • true: 呼び出しは成功しました。

    • false: 呼び出しは失敗しました。

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateSubscribeRelation
&OtaEventFlag=true
&ProductKey=a1Zkii7****
&Type=AMQP
&ConsumerGroupIds.1=Xs95KifeaSKbi8tKkcoD00****
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

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

    JSON 形式

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

    エラーコード

    エラーコードのリストについては、API エラーセンター をご参照ください。