すべてのプロダクト
Search

このプロダクト

    IoT Platform:共通パラメーター

    ドキュメントセンター

    IoT Platform:共通パラメーター

    最終更新日:Mar 22, 2025

    このトピックでは、IoT Platform API の共通リクエストパラメーターと共通レスポンスパラメーターについて説明します。

    共通リクエストパラメーター

    共通リクエストパラメーターは、すべての IoT Platform API リクエストに含める必要があります。

    パラメーター

    タイプ

    必須

    説明

    Format

    String

    いいえ

    レスポンスを返す形式。有効な値： JSON および XML。デフォルト値： XML。

    Version

    String

    はい

    API のバージョン番号。値は YYYY-MM-DD 形式です。

    有効な値：

    • 2018-01-20。

    AccessKeyId

    String

    はい

    Alibaba Cloud によって提供される AccessKey ID。

    AccessKey ペアを作成または表示するには、次の手順を実行します。[alibaba Cloud 管理コンソール] にログオンし、ポインターをプロフィール画像の上に移動して、[accesskey 管理] をクリックします。[AccessKey ペア] ページで、AccessKey ペアを表示または作成します。

    Signature

    String

    はい

    現在のリクエストの署名文字列。署名の計算方法の詳細については、「署名方式」をご参照ください。

    SignatureMethod

    String

    はい

    署名文字列の暗号化方式。値を HMAC-SHA1 に設定します。

    Timestamp

    String

    はい

    リクエストのタイムスタンプ。ISO 8601 標準で時間を指定します。時間は UTC でなければなりません。形式： YYYY-MM-DDThh:mm:ssZ。

    たとえば、このパラメーターを 2016-01-04T12:00:00Z に設定できます。これは、2016 年 1 月 4 日 20:00:00 UTC + 08:00 を示します。

    SignatureVersion

    String

    はい

    署名暗号化アルゴリズムのバージョン番号。値を 1.0 に設定します。

    SignatureNonce

    String

    はい

    リプレイ攻撃を防ぐために使用される一意の乱数。リクエストごとに異なる番号を使用する必要があります。

    RegionId

    String

    はい

    デバイスが存在するリージョンの ID。リージョンは、IoT Platform コンソールで指定したリージョンと同じである必要があります。例： cn-shanghai。

    IoT Platform でサポートされているリージョンの ID の詳細については、「サポートされているリージョン」をご参照ください。

    例：

    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

    共通レスポンスパラメーター

    API レスポンスは HTTP レスポンス形式を使用します。2xx ステータスコードは呼び出しの成功を示し、4xx または 5xx ステータスコードは呼び出しの失敗を示します。レスポンスは JSON または XML 形式で返すことができます。リクエストでレスポンス形式を指定できます。デフォルトのレスポンス形式は XML です。

    各レスポンスには、呼び出しが成功したかどうかに関係なく、RequestId パラメーターで示される一意のリクエスト ID が含まれています。

    • 成功レスポンスの例

      • XML 形式

        • バージョン 2018-01-20 の IoT Platform API

          <?xml version="1.0" encoding="UTF-8"?>
<!--結果ルートノード-->
<操作名 + Response>
    <!--リクエストタグを返す-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--結果データを返す-->
</API 操作名+Response>

      • JSON 形式

        {
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 返されたデータ */
}

    • エラーレスポンスの例

      API 操作の呼び出し時にエラーが発生した場合、結果データは返されません。エラーコードを使用して、エラーの原因を特定できます。

      API 操作の呼び出し時にエラーが発生した場合、4XX または 5XX の HTTP ステータスコードが返されます。返されたメッセージには、特定のエラーコードとエラーメッセージが含まれています。返されたメッセージには、RequestId パラメーターで返されるグローバルに一意のリクエスト ID も含まれています。発生したエラーを確認できない場合は、Alibaba Cloud カスタマーサービスに連絡するか、チケットを送信してください。サポートを受けるには、リクエスト ID を提供する必要があります。

      • 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>

      • JSON 形式

        {
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}