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

プロダクトのタグを作成します。

使用方法

1 回の呼び出しで、プロダクトに最大 10 個のタグを作成できます。
各プロダクトには最大 100 個のタグを設定できます。

重要タグキーとタグ値を指定する必要があります。指定しないと、呼び出しは失敗します。タグ値の詳細については、このトピックの「リクエストパラメーター」セクションをご参照ください。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	CreateProductTags	実行する操作。値を CreateProductTags に設定します。
ProductKey	String	はい	a1BwAGV****	プロダクトの ProductKey。ProductKey は、IoT Platform がプロダクトに発行する GUID です。 IoT Platform コンソールを使用するか、QueryProductList 操作を呼び出して、現在のアカウント内のすべてのプロダクトに関する情報を表示できます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの概要ページでインスタンスの ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して概要ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductTag.N.TagKey	String	いいえ	room	プロダクトタグのキー。各キーは 1 ～ 30 文字で、文字、数字、ピリオド（.）を含めることができます。重要 `abc` は、IoT Platform によって予約されているキーです。キーを `abc` に設定することはできません。`key` を abc に設定すると、タグをクエリするときにキーは自動的に除外されます。
ProductTag.N.TagValue	String	いいえ	TagValue	プロダクトタグの値。各タグ値は 1 ～ 128 文字で、文字、数字、アンダースコア（_）、ハイフン（-）を含めることができます。

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

レスポンスパラメーター

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

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTags
&ProductKey=a1h7knJ****
&ProductTag.1.TagKey=first
&ProductTag.1.TagValue=value1
&ProductTag.2.TagKey=second
&ProductTag.2.TagValue=value2
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<CreateProductTagsResponse>
      <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
      <Success>true</Success>
</CreateProductTagsResponse>

JSON 形式

{
  "RequestId": "354A4F9B-6B01-4498-8084-867F59720BA5",
  "Success": true
}

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。