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

グループタグを追加、更新、または削除します。

使用方法

デバイスグループには最大 100 個のタグを設定できます。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	SetDeviceGroupTags	実行する操作。値を SetDeviceGroupTags に設定します。
GroupId	String	はい	W16X8Tvdosec****	グループの ID。ID は、グループのグローバル一意識別子（GUID）です。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの [概要] ページで、インスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。 IoT Platform コンソールに [概要] ページまたはインスタンス ID が表示されない場合は、このパラメーターを設定する必要はありません。インスタンスの詳細については、「概要」をご参照ください。
TagString	String	いいえ	[{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]	JSON 形式のタグデータ。TagString パラメーターは、キーと値のペアの形式で複数のタグを指定します。各タグに tagKey と tagValue を指定する必要があります。 tagKey: タグキー。キーは 2 ～ 30 文字で、英字、数字、ピリオド（.）を含めることができます。 tagValue: タグ値。各値には、英字、数字、アンダースコア（_）、ハイフン（-）を含めることができます。値は 1 ～ 128 文字である必要があります。複数のタグはカンマ（,）で区切ります。例: `[{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]` 既存のタグに新しい値を指定すると、新しいタグ値は元の値を上書きします。タグを削除する場合、タグのキーと値を指定する必要はありません。重要 `abc` は IoT Platform によって予約されているキーです。tagKey を abc に設定することはできません。`tagKey` を abc に設定すると、タグをクエリするときに abc タグは自動的にフィルタリングされます。
GroupType	String	いいえ	LINK_PLATFORM_DYNAMIC	グループのタイプ。このパラメーターを設定する必要はありません。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。エラーコードの詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	12CFDAF1-99D9-42E0-8C2F-F281DA5E8953	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceGroupTags
&GroupId=W16X8Tvdosec****
&TagString=[{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<SetDeviceGroupTagsResponse>
      <RequestId>12CFDAF1-99D9-42E0-8C2F-F281DA5E8953</RequestId>
      <Success>true</Success>
</SetDeviceGroupTagsResponse>

JSON 形式

{
    "RequestId":"12CFDAF1-99D9-42E0-8C2F-F281DA5E8953",
    "Success":true
}

エラーコード

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