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

1 つ以上の ECS リソースにバインドされているタグを照会します。

操作説明

操作の説明

クエリのオブジェクトを決定するために、リクエストで以下のパラメーターのうち少なくとも 1 つを指定してください。

ResourceId.N
Tag.N (Tag.N.Key および Tag.N.Value)
TagFilter.N

以下のパラメーターを同時に指定した場合、応答には両方の条件を満たす 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 を呼び出します。	cn-hangzhou
RegionId	string	必須	リソースのリージョン ID。最新のリージョンリストをクエリするには、 DescribeRegions を呼び出します。	cn-hangzhou
NextToken	string	任意	次のクエリを開始するために使用されるトークン。	caeba0bbb2be03f84eb48b699f0a4883
ResourceType	string	必須	リソースタイプ。有効な値: instance: ECS インスタンス。 disk: クラウドディスク。 snapshot: スナップショット。 image: イメージ。 securitygroup: セキュリティグループ。 volume: ストレージボリューム。 eni: Elastic Network Interface (ENI)。 ddh: 専用ホスト。 ddhcluster: 専用ホストクラスター。 keypair: SSH キーペア。 launchtemplate: 起動テンプレート。 reservedinstance: リザーブドインスタンス。 snapshotpolicy: 自動スナップショットポリシー。 elasticityassurance: エラスティシティ保証。 capacityreservation: キャパシティ予約。 command: クラウドアシスタントコマンド。 invocation: クラウドアシスタントコマンドの実行結果またはファイル送信結果。 activation: クラウドアシスタントホストインスタンスのアクティベーションコード。 managedinstance: クラウドアシスタントホストインスタンス。	instance
ResourceId	array	任意	ECS リソースの ID。N の有効値: 1～50。	i-bp1j6qtvdm8w0z1o****
	string	任意	ECS リソースの ID。N の有効値: 1～50。	i-bp1j6qtvdm8w0z1o****
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	ECS リソースの完全一致検索を実行するために使用されるタグキー。タグキーの長さは 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 を設定します。 `Key` が `acs:rm:rgId` に設定されている場合、`Value` にはデフォルト以外のリソースグループ ID のみを設定できます。指定されたリソースグループ ID がデフォルトのリソースグループである場合、エラーメッセージが返されます。 `Key` が `acs:rm:rgId` に設定されている場合、他のタグキーと値のペアを指定することはできません。複数の `Tag.N` パラメーターを使用してリソースグループとタグで同時にリソースをクエリする場合、エラーメッセージが返されます。	TestKey
Value	string	任意	ECS リソースの完全一致検索を実行するために使用されるタグ値。タグ値の長さは 1～128 文字である必要があります。N の有効値: 1～20。説明 `Key=acs:rm:rgId` の場合、このパラメーターにはリソースグループ ID のみを設定でき、そのリソースグループ ID はデフォルトのリソースグループであってはなりません。	TestValue
TagFilter	array<object>	任意	タグフィルタールール。説明このパラメーターは招待プレビュー中であり、一般公開されていません。
	object	任意	タグフィルタールール。
TagValues	array	任意	ECS リソースのあいまい検索を実行するために使用されるタグ値。タグ値の長さは 1～128 文字である必要があります。N の有効値: 1～5。メトリックの説明については、`TagFilter.N.TagKey` パラメーターの説明を参照してください。	TestTagFilter
	string	任意	ECS リソースのあいまい検索を実行するために使用されるタグ値。タグ値の長さは 1～128 文字である必要があります。N の有効値: 1～5。メトリックの説明については、`TagFilter.N.TagKey` パラメーターの説明を参照してください。	TestTagFilter
TagKey	string	任意	ECS リソースのあいまい検索を実行するために使用されるタグキー。タグキーの長さは 1～128 文字である必要があります。N の有効値: 1～5。 `TagFilter.N` は、指定されたタグがバインドされている ECS リソースのあいまい検索を実行するために使用されます。これはキーと 1 つ以上の値で構成されます。あいまい検索には最大 2 秒の遅延が発生する可能性があり、あいまいフィルター適用後のリソース数が 5,000 以下であるシナリオのみをサポートします。タグキー (`TagFilter.N.TagKey`) で ECS リソースのあいまい検索を実行する場合、タグ値 (`TagFilter.N.TagValues.N`) は空である必要があります。たとえば、タグキーが `environment` である ECS リソースのあいまい検索を実行するには、`TagFilter.1.TagKey` に `env` (プレフィックス一致)、`env` (部分一致)、または `env` (完全に一致) を設定でき、`TagFilter.1.TagValues` は空にする必要があります。タグ値 (`TagFilter.N.TagValues.N`) で ECS リソースのあいまい検索を実行する場合、タグキー (`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.

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

変更履歴

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