ListTagResources - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

1 つ以上の Elastic Compute Service (ECS) リソースのタグを一覧表示します。

操作説明

API

特定のリソースを検索するには、リクエストに次のパラメーターを 1 つ以上含めてください。

ResourceId.N
Tag.N (Tag.N.Key と Tag.N.Value)
TagFilter.N

次のパラメーターの組み合わせを指定した場合、API はすべての条件に一致する ECS リソースのみを返します。

Tag.N と ResourceId.N
TagFilter.N と ResourceId.N

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:ListTagResources

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リソースが所在するリージョンの ID です。DescribeRegions API を呼び出して、Alibaba Cloud リージョンの最新リストを表示できます。	cn-hangzhou
RegionId	string	必須		cn-hangzhou
NextToken	string	任意	次のページの結果を取得するためのページネーショントークンです。	caeba0bbb2be03f84eb48b699f0a4883
ResourceType	string	必須	リソースタイプです。有効な値： instance：ECS インスタンス disk：ディスク snapshot：スナップショット image：イメージ securitygroup：セキュリティグループ volume：ボリューム eni：Elastic ネットワークインターフェイス ddh：専有ホスト ddhcluster：専有ホストクラスター keypair：SSH キーペア launchtemplate：起動テンプレート reservedinstance：リザーブドインスタンス snapshotpolicy：スナップショットポリシー elasticityassurance：Elasticity Assurance capacityreservation：キャパシティ予約 command：クラウドアシスタントのコマンド invocation：クラウドアシスタントにおけるコマンド実行またはファイル配信の結果 activation：クラウドアシスタントのマネージドインスタンスのアクティベーションコード managedinstance：クラウドアシスタントのマネージドインスタンス	instance
ResourceId	array	任意	ECS リソースの ID です。N の値は 1～50 です。	i-bp1j6qtvdm8w0z1o****
	string	任意		i-bp1j6qtvdm8w0z1o****
Tag	array<object>	任意	タグのリストです。
	object	任意
Key	string	任意	完全一致に使用するタグキーです。タグキーは 1～128 文字である必要があります。N の値は 1～20 です。 `Tag.N` パラメーターの使用上の注意：方法 1：特定のタグを持つ ECS リソースを検索する場合 `Tag.N.Key` のみを指定した場合、指定されたタグキーを持つすべてのリソースが返されます。 `Tag.N.Value` のみを指定した場合、`InvalidParameter.TagValue` エラーが返されます。複数のキーと値のペアを指定した場合、それらすべてに一致する ECS リソースのみが返されます。方法 2：デフォルト以外のリソースグループ内のリソースを照会する場合 `Key` を `acs:rm:rgId` に設定した場合、`Value` をデフォルト以外のリソースグループの ID に設定する必要があります。デフォルトのリソースグループの ID を指定すると、エラーが返されます。 `Key` を `acs:rm:rgId` に設定した場合、他のキーと値のペアを指定することはできません。複数の `Tag.N` パラメーターを使用してリソースグループとタグの両方でリソースを照会すると、エラーが返されます。	TestKey
Value	string	任意	完全一致に使用するタグ値です。タグ値は 1～128 文字である必要があります。N の値は 1～20 です。説明 `Key` が `acs:rm:rgId` の場合、このパラメーターをデフォルト以外のリソースグループの ID に設定する必要があります。	TestValue
TagFilter	array<object>	任意	タグフィルターのリストです。説明このパラメーターは招待制プレビューのため、まだご利用いただけません。
	object	任意
TagValues	array	任意	あいまい一致に使用するタグ値です。タグ値は 1～128 文字である必要があります。N の値は 1～5 です。詳細については、`TagFilter.N.TagKey` パラメーターの説明をご参照ください。	TestTagFilter
	string	任意		TestTagFilter
TagKey	string	任意	あいまい一致に使用するタグキーです。タグキーは 1～128 文字である必要があります。N の値は 1～5 です。 `TagFilter.N` パラメーターを使用して、タグのあいまい一致を行い、一致する ECS リソースを検索します。各フィルターは、1 つのキーと 1 つ以上の値で構成されます。あいまい一致には 2 秒のレイテンシーが発生する場合があり、フィルタリング後に 5,000 以下のリソースを返すクエリでのみサポートされます。タグキー (`TagFilter.N.TagKey`) であいまい一致を行うには、タグ値 (`TagFilter.N.TagValues.N`) を空にする必要があります。たとえば、タグキー `environment` を持つ ECS リソースを検索するには、`TagFilter.1.TagKey` を `env` (前方一致)、`env` (部分一致)、または `env` (完全一致) に設定できますが、`TagFilter.1.TagValues` は空にする必要があります。タグ値 (`TagFilter.N.TagValues.N`) であいまい一致を行うには、タグキー (`TagFilter.N.TagKey`) を正確な値に設定する必要があります。たとえば、タグキー `env` とタグ値 `product` を持つ ECS リソースを検索するには、`TagFilter.1.TagKey` を `env` に設定する必要があります。次に、`TagFilter.1.TagValues.1` を `proc` (前方一致)、`proc` (部分一致)、または `proc` (完全一致) に設定できます。同じ `TagKey` に対しては、1 つの検索パターンしか使用できません。複数のパターンを指定した場合、システムは最初のパターンのみを使用します。タグキーは、論理 AND を使用して結合されます。指定されたすべてのタグキーに一致する ECS リソースのみが返されます。同じタグキーのタグ値は、論理 OR を使用して結合されます。そのタグキーに指定されたいずれかのタグ値に一致する ECS リソースが返されます。説明同じリクエストで `TagFilter.N` パラメーターと `Tag.N` パラメーターの両方を指定することはできません。	env

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のページを取得するためのトークンです。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	リクエスト ID です。	484256DA-D816-44D2-9D86-B6EE4D5BA78C
TagResources	object
TagResource	array<object>	タグとリソースの関連情報の配列です。配列内の各オブジェクトには、リソース ID、リソースタイプ、タグキー、およびタグ値が含まれます。
	object
TagValue	string	タグ値です。	TestValue
ResourceType	string	リソースタイプです。有効な値： `instance`：ECS インスタンス `disk`：ディスク `snapshot`：スナップショット `image`：イメージ `securitygroup`：セキュリティグループ `volume`：ボリューム `eni`：弾性ネットワークインターフェイス `ddh`：専用ホスト `ddhcluster`：専用ホストクラスター `keypair`：SSH キーペア `launchtemplate`：起動テンプレート `reservedinstance`：リザーブドインスタンス `snapshotpolicy`：自動スナップショットポリシー `elasticityassurance`：弾力性保証 `capacityreservation`：キャパシティ予約 `command`：コマンド `invocation`：実行結果 `activation`：マネージドインスタンスのアクティベーションコード `managedinstance`：マネージドインスタンス	instance
ResourceId	string	リソース ID です。	i-bp1j6qtvdm8w0z1o****
TagKey	string	タグキーです。	TestKey

例

成功レスポンス

JSONJSON

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "TestValue",
        "ResourceType": "instance",
        "ResourceId": "i-bp1j6qtvdm8w0z1o****",
        "TagKey": "TestKey"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDefaultResourceGroup.NotSupported	The specified parameter Tag is not support for default resource group.
400	InvalidTag.NotSupported	You can only specify Tag for either resource tag or resource group.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed , Valid : 50.
400	NumberExceed.Tags	The Tags parameter's number is exceed , Valid : 20.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.
400	InvalidTagCount	The specified tags are beyond the permitted range.
400	Invalid.Scope	The specified scope is invalid.
400	InvalidTags.MalFormed	The tags must be empty, when the tagFilters is not empty.
500	ServiceUnavailable	The service is unavailable, please try again later.
500	InternalError	The process of creating snapshot has failed due to some unknown error.
403	PermissionDenied.TagOwnerBid	The specified operator not have permission to set TagOwnerBid value.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.
403	NoPermission.Tag	The operator is not permission for the tag.
403	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.
403	PermissionDenied.TagsFuzzyQuery	The specified operator has not permission to query fuzzy tags.
403	NumberExceed.TagValues	The number of the specified TagValues is beyond permitted range, the max is 5.
403	InvalidFilter.Malformed	The specified Filter is not valid.
403	InvalidTagFilter.Malformed	The specified TagFilter is not valid.
403	Invalid.NextToken	The specified NextToken is not valid.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	MissingParameter.ResourceIds	The parameter - ResourceIds.N should not be null.
404	MissingParameter.TagOwnerUid	The parameter - TagOwnerUid should not be null.
404	MissingParameter.TagOwnerBid	The parameter - TagOwnerBid should not be null.
404	MissingParameter.ResourceType	The parameter - ResourceType should not be null.
404	MissingParameter.Tags	The parameter - Tags should not be null.
404	MissingParameter.RegionId	The parameter - RegionId should not be null.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.

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

変更履歴

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