すべてのプロダクト
Search
ドキュメントセンター

Elastic Compute Service:DescribeResourceByTags

最終更新日:Apr 16, 2026

DescribeResourceByTags API は、タグまたはリソースタイプに基づいてリソースを取得します。

説明

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

今すぐお試しください

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

PageSize

integer

任意

ページあたりのエントリ数。最大値:100。

デフォルト値:50。

50

PageNumber

integer

任意

返すページ番号。最小値は 1 です。

デフォルト値:1。

1

ResourceType

string

任意

リソースタイプ。有効な値:

  • instance:ECS インスタンス。

  • disk:ディスク。

  • snapshot:スナップショット。

  • image:イメージ。

  • securitygroup:セキュリティグループ。

  • volume:ボリューム。

  • eni:Elastic Network Interface。

  • ddh:専用ホスト。

  • keypair:キーペア。

  • launchtemplate:起動テンプレート。

すべての値は小文字で指定する必要があります。

instance

RegionId

string

必須

リソースが所在するリージョンの ID。DescribeRegions を呼び出して、Alibaba Cloud のリージョンの最新リストを参照できます。

cn-hangzhou

Tag

array<object>

任意

タグのリスト。

object

任意

タグオブジェクト。

key

string

任意

タグキー。

説明

互換性を最大限確保するため、Tag.N.Key パラメーターを使用することを推奨します。

testkey

Key

string

任意

タグキー。

説明

互換性を最大限確保するため、Tag.N.Key パラメーターを使用することを推奨します。

TestKey

Value

string

任意

タグ値。空の文字列を指定できます。値は最大 128 文字です。

TestValue

value

string

任意

タグ値。空の文字列を指定できます。値は最大 128 文字です。

testvalue

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエスト ID。

1C1E5359-71D7-44D8-8FAA-0327B549157X

PageSize

integer

ページあたりのエントリ数。

50

PageNumber

integer

ページ番号。

1

TotalCount

integer

リソースの総数。

8

Resources

object

Resource

array<object>

タグが追加されているリソースの情報。

object

ResourceType

string

リソースタイプ。

instance

ResourceId

string

リソース ID。

i-bp16t2cgmiiy7t1c****

RegionId

string

リージョン ID。

cn-hangzhou

例

成功レスポンス

JSONJSON

{
  "RequestId": "1C1E5359-71D7-44D8-8FAA-0327B549157X",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 8,
  "Resources": {
    "Resource": [
      {
        "ResourceType": "instance",
        "ResourceId": "i-bp16t2cgmiiy7t1c****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidTagCount The specified tags are beyond the permitted range.
404 InvalidRegionId.NotFound The specified RegionId does not exist.
404 InvalidResourceType.NotFound The ResourceType provided does not exist in our records.

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

変更履歴

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