ListTagResources によるタグとリソースのクエリ - ECS

EBS リソースに追加されたタグを照会するか、デフォルト以外のリソースグループ内のリソースの ID とタグを照会します。

操作説明

リクエストで次のパラメーターまたはパラメーターペアの少なくとも 1 つを指定して、クエリオブジェクトを決定します。

ResourceId.N
Tag.N パラメーターペア (Tag.N.Key と Tag.N.Value)

Tag.N と ResourceId.N を同時に設定した場合、両方のパラメーターに一致する EBS リソースが返されます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ebs:ListTagResources

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceId	array	任意	リソースの ID リスト。各呼び出しで最大 50 個のリソース ID を指定できます。	disk-123
	string	任意	リソース N の ID。N の有効値：1～50。	pair-cn-c4d2t7f****
Tag	array<object>	任意	タグに関する情報。各呼び出しで最大 20 個のタグを指定できます。
	object	任意	リソースにアタッチするタグ。
Key	string	任意	EBS リソースの完全一致検索に使用されるタグ N のキー。タグキーの長さは 1～128 文字である必要があります。N の有効値：1～20。 `Tag.N` パラメーターペア (Tag.N.Key と Tag.N.Value) は、指定されたタグが追加された EBS リソースの完全一致検索に使用されます。各タグはキーと値のペアです。 `Tag.N.Key` のみを指定した場合、指定されたタグキーを含むタグを持つすべての EBS リソースが返されます。 `Tag.N.Value` のみを指定した場合、`InvalidParameter.TagValue` エラーが返されます。複数のタグキーと値のペアを同時に指定した場合、すべてのタグキーと値のペアに一致する EBS リソースのみが返されます。	tag-key
Value	string	任意	EBS リソースの完全一致検索に使用されるタグ N の値。タグ値の長さは 1～128 文字である必要があります。N の有効値：1～20。	tag-value
NextToken	string	任意	次のクエリを開始するために使用されるトークン。	token123
RegionId	string	必須	リソースのリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
ResourceType	string	必須	リソースのタイプ。有効値： dedicatedblockstoragecluster：専用ブロックストレージクラスター diskreplicapair：レプリケーションペア diskreplicagroup：レプリケーション整合性グループ	diskreplicagroup
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。ClientToken の値には ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性の確保方法」をご参照ください。	0c593ea1-3bea-11e9-b96b-88e9fe63****

レスポンスフィールド

フィールド	型	説明	例
	object	ListTagResourcesResponse
NextToken	string	次のクエリを開始するために使用されるトークン。	caeba0bbb2be03f84eb48b699f0a****
TagResources	array<object>	リソース ID、リソースタイプ、タグのキーと値のペアなど、リソースとタグに関する詳細。
	object	タグが追加されたリソースに関する詳細。
TagKey	string	リソースのタグキー。	TestKey
TagValue	string	リソースのタグ値。	TestValue
ResourceId	string	リソースの ID。	pair-cn-c4d2t7f****
ResourceType	string	リソースのタイプ。有効値： dedicatedblockstoragecluster：専用ブロックストレージクラスター diskreplicapair：レプリケーションペア diskreplicagroup：レプリケーション整合性グループ	pair
RequestId	string	リクエストの ID。リクエスト ID は、呼び出しが成功したかどうかに関係なく返されます。	484256DA-D816-44D2-9D86-B6EE4D5B****

例

成功レスポンス

JSONJSON

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "TagResources": [
    {
      "TagKey": "TestKey",
      "TagValue": "TestValue",
      "ResourceId": "pair-cn-c4d2t7f****",
      "ResourceType": "pair"
    }
  ],
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5B****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The parameter %s is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	日文说明
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.
400	NumberExceed.ResourceIds	The ResourceIds parameter number is exceed , Valid : 50
400	NumberExceed.Tags	NumberExceed.Tags
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
400	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
403	OperationDenied	The operation is not allowed.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

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

変更履歴

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