TagResources API による MQTT リソースへのタグ付け - ApsaraMQ for MQTT

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:TagResources

create

*All Resource

*

なし

mq:MqttInstanceAccess

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ResourceType	string	必須	リソースタイプ。値は instance である必要があります。	instance
ResourceId	array	必須	リソース ID のリスト。
	string	任意	リソース ID。現在、インスタンスのみがサポートされています。	mqtt-cn-5yd3xxx
Tag	array<object>	必須	タグのリスト。一度に最大 20 個のタグを追加できます。 1 つのリソースには最大 20 個のタグを付けることができます。
	object	任意	リソースのタグオブジェクト。
Key	string	任意	タグキー。	test
Value	string	任意	タグ値。	test

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	返されるオブジェクト。
RequestId	string	リクエストの ID。	82B9E503-F4A1-4F30-976F-C6999FF9****
Code	string	API 呼び出しの状態コード。	200
Data	boolean	呼び出しの結果。	true
Message	string	返されたメッセージ。	operation success.

例

成功レスポンス

JSONJSON

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": "200",
  "Data": true,
  "Message": "operation success."
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MqttOwnerCheckError	Failed to validate the instance permission
400	ResourceIdNotFound	resourceId does not exist.
403	PermissionCheckFailed	Failed to verify API permissions.

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

変更履歴

完全なリストについては、「変更履歴」をご参照ください。