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

利用可能なタグを照会します。リソースタイプ、リソース ID、タグキー、またはタグ値に基づいてタグの条件付きクエリを実行できます。フィルター条件は論理 AND (&&) 演算子を使用して評価され、すべてのフィルター条件を満たすタグのみが返されます。

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Tag(2018-08-28) - CountResourcesByTags への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

操作説明

タグキー (Tag.N.Key) を指定してタグ値 (Tag.N.Value) を指定しない場合、そのタグキーに関連付けられたすべてのタグキーと値のペアが返されます。タグキーと値のペアを指定した場合、そのキーと値のペアに完全に一致するタグのみが返されます。

今すぐお試しください

この 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:DescribeTags

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。最大値: 100。デフォルト値: 50。	50
PageNumber	integer	任意	タグリストのページ番号。最小値: 1。デフォルト値: 1。	1
ResourceType	string	任意	リソースタイプ。有効な値: instance: ECS インスタンス。 disk: クラウドディスク。 snapshot: スナップショット。 image: イメージ。 securitygroup: セキュリティグループ。 volume: ストレージボリューム。 eni: ネットワークインターフェース (NIC)。 ddh: 専用ホスト。 keypair: SSH キーペア。 launchtemplate: 起動テンプレート。 reservedinstance: リザーブドインスタンス。 snapshotpolicy: 自動スナップショットポリシー。すべての有効な値は小文字です。	snapshot
ResourceId	string	任意	タグがアタッチされているリソースの ID。たとえば、リソースタイプ (ResourceType) が instance の場合、リソース ID はインスタンス ID です。	s-946ntx4wr****
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
Category	string	任意	説明このパラメーターは廃止予定です。互換性を確保するために、他のパラメーターを使用してください。	null
Tag	array<object>	任意	タグのリスト。
	object	任意	タグのリスト。
key	string	任意	リソースのタグキー。説明互換性を確保するために、Tag.N.Key パラメーターを使用してください。	testkey
Key	string	任意	リソースのタグキー。N の有効な値: 1～20。タグキーは空の文字列にできません。タグキーは最大 64 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。	TestKey
Value	string	任意	リソースのタグ値。N の有効な値: 1～20。タグ値は空の文字列にできます。タグ値は最大 128 文字で、aliyun または acs: で始めることはできません。タグ値に http:// または https:// を含めることはできません。	TestValue
value	string	任意	リソースのタグ値。説明互換性を確保するために、Tag.N.Value パラメーターを使用してください。	testvalue

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID	B04B8CF3-4489-432D-83BA-6F128E4F2295
PageSize	integer	ページングクエリの 1 ページあたりのエントリ数の設定項目。ページングサイズです。	50
PageNumber	integer	タグリストのページ番号。	1
TotalCount	integer	タグの総数。	1
Tags	object
Tag	array<object>	すべてのフィルター条件を満たすタグ。
	array<object>	すべてのフィルター条件を満たすタグ。
TagValue	string	タグ値。	TestValue
TagKey	string	タグキー。	TestKey
ResourceTypeCount	object	タグが付与されているリソースの数。
Instance	integer	タグが付与されているインスタンスの数。	45
Image	integer	タグが付与されているイメージの数。	6
Ddh	integer	タグが付与されている専用ホストの数。	1
SnapshotPolicy	integer	タグが付与されている自動スナップショットポリシーの数。	4
Securitygroup	integer	タグが付与されているセキュリティグループの数。	4
Snapshot	integer	タグが付与されているスナップショットの数。	15
ReservedInstance	integer	タグが付与されているリザーブドインスタンスの数。	4
LaunchTemplate	integer	タグが付与されている起動テンプレートの数。	6
Eni	integer	タグが付与されている Elastic Network Interface (ENI) の数。	5
Disk	integer	タグが付与されているディスクの数。	15
KeyPair	integer	タグが付与されているキーペアの数。	17
Volume	integer	タグが付与されているストレージボリュームの数。	6

例

成功レスポンス

JSONJSON

{
  "RequestId": "B04B8CF3-4489-432D-83BA-6F128E4F2295",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 1,
  "Tags": {
    "Tag": [
      {
        "TagValue": "TestValue",
        "TagKey": "TestKey",
        "ResourceTypeCount": {
          "Instance": 45,
          "Image": 6,
          "Ddh": 1,
          "SnapshotPolicy": 4,
          "Securitygroup": 4,
          "Snapshot": 15,
          "ReservedInstance": 4,
          "LaunchTemplate": 6,
          "Eni": 5,
          "Disk": 15,
          "KeyPair": 17,
          "Volume": 6
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTagCount	The specified tags are beyond the permitted range.
400	InvalidTagKey.Malformed	The parameter Tag.n.Key is illegal.
400	InvalidTagValue.Malformed	The parameter Tag.n.Value is illegal.
400	Invalid.TagCategory	The parameter Category is illegal.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.

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

変更履歴

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