ListProductTags - IoT Platform - Alibaba Cloud ドキュメントセンター

プロダクトのすべてのタグをクエリします。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	ListProductTags	実行する操作。値を ListProductTags に設定します。
ProductKey	String	はい	a1BwAGV****	プロダクトの ProductKey。ProductKey は、IoT Platform がプロダクトに発行する GUID です。IoT Platform [コンソール]を使用するか、QueryProductList オペレーションを呼び出して、現在のアカウント内のすべてのプロダクトに関する情報を表示できます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。 IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	ProductTag の配列		呼び出しが成功した場合に返されるプロダクトタグ。ProductTag パラメーターに含まれるパラメーターの詳細については、以下を参照してください。
ProductTag
TagKey	String	room	各タグのキー。
TagValue	String	102	タグの値。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListProductTags
&ProductKey=a1h7knJ****
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListProductTagsResponse>
      <Data>
            <ProductTag>
                  <TagValue>alterTable</TagValue>
                  <TagKey>binary</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>json2</TagValue>
                  <TagKey>extt</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>1234</TagValue>
                  <TagKey>Lock</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>support</TagValue>
                  <TagKey>Lockk</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>reen</TagValue>
                  <TagKey>Reen</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>try</TagValue>
                  <TagKey>Reenn</TagKey>
            </ProductTag>
            <ProductTag>
                  <TagValue>DropTable</TagValue>
                  <TagKey>roc</TagKey>
            </ProductTag>
      </Data>
      <RequestId>7FBE60F8-4AB5-4A8C-AFCB-F4F38851F01F</RequestId>
      <Success>true</Success>
</ListProductTagsResponse>

JSON 形式

{
  "Data": {
    "ProductTag": [
      {
        "TagValue": "alterTable",
        "TagKey": "binary"
      },
      {
        "TagValue": "json2",
        "TagKey": "extt"
      },
      {
        "TagValue": "1234",
        "TagKey": "Lock"
      },
      {
        "TagValue": "support",
        "TagKey": "Lockk"
      },
      {
        "TagValue": "reen",
        "TagKey": "Reen"
      },
      {
        "TagValue": "try",
        "TagKey": "Reenn"
      },
      {
        "TagValue": "DropTable",
        "TagKey": "roc"
      }
    ]
  },
  "RequestId": "7FBE60F8-4AB5-4A8C-AFCB-F4F38851F01F",
  "Success": true
}

エラーコード

エラーコードの一覧については、API エラーセンターをご覧ください。