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

Virtual Private Cloud:DescribeTags

最終更新日:Jun 19, 2026

指定されたフィルター条件を満たすタグのリストを照会します。

操作説明

  • クエリオブジェクトを決定するために、リクエストで少なくとも ResourceId.N または Tag.NTag.N.KeyTag.N.Value)を指定してください。

  • Tag.N はリソースのタグであり、キーと値のペアで構成されます。Tag.N.Key のみを指定した場合、そのタグキーに関連付けられたすべてのタグ値が返されます。Tag.N.Value のみを指定した場合、エラーが返されます。

  • タグをフィルターするために Tag.NResourceId.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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:DescribeTags

get

*全部资源

*

  • vpc:tag
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ResourceType

string

任意

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

  • VPC: 仮想非公開クラウド(VPC)インスタンス。

  • VSWITCH: vSwitch インスタンス。

  • ROUTETABLE: ルートテーブルインスタンス。

  • EIP: EIP インスタンス。

  • VPNGATEWAY: VPN ゲートウェイインスタンス。

  • NATGATEWAY: NAT Gateway インスタンス。

  • COMMONBANDWIDTHPACKAGE: インターネット共有帯域幅インスタンス。

  • PREFIXLIST: プレフィックスリストインスタンス。

  • PUBLICIPADDRESSPOOL: IP アドレスプールインスタンス。

  • IPV4GATEWAY: IPv4 ゲートウェイインスタンス。

  • IPV6GATEWAY: IPv6 ゲートウェイインスタンス。

  • NETWORKACL: ネットワーク ACL インスタンス。

  • TRAFFICMIRRORFILTER: トラフィックミラーフィルターインスタンス。

  • TRAFFICMIRRORSESSION: トラフィックミラー会話インスタンス。

  • FLOWLOG: フローログインスタンス。

  • HAVIP: 高可用性仮想 IP アドレスインスタンス。

  • DHCPOPTIONSSET: DHCP オプションセットインスタンス。

  • GATEWAYENDPOINT: ゲートウェイエンドポイントインスタンス。

説明

リソースタイプの値は大文字と小文字を区別しません。

VPC

RegionId

string

必須

リソースのリージョン ID。

DescribeRegions 操作を呼び出してリージョン ID をクエリできます。

cn-hangzhou

NextToken

string

任意

ページネーショントークン。有効な値:

  • 最初のクエリまたは後続のクエリが存在しない場合、このパラメーターを空のままにします。

  • 後続のクエリが存在する場合、このパラメーターを前回の API 呼び出しで返された NextToken 値に設定します。

FFmyTO70tTpLG6I3FmYAXGKPd****

MaxResult

integer

任意

1 ページあたりのエントリ数。有効な値: 1~50。デフォルト値: 50。

50

ResourceId

array

任意

リソース ID。最大 50 個のリソース ID を指定できます。

string

任意

リソース ID。最大 50 個のリソース ID を指定できます。

説明

このパラメーターを指定する場合、ResourceType パラメーターも指定する必要があります。

vpc-bp16qjewdsunr41m1****

Tag

array<object>

任意

リソースのタグ。

object

任意

リソースのタグ。

Key

string

任意

リソースのタグキー。最大 20 個のタグキーを指定できます。

タグキーは最大 128 文字で、空の文字列にすることはできません。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

FinanceDept

Value

string

任意

リソースのタグ値。最大 20 個のタグ値を指定できます。

タグ値は最大 128 文字で、空の文字列にすることはできますが、aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

FinanceJoshua

レスポンスフィールド

フィールド

説明

object

オブジェクト。

NextToken

string

ページネーショントークン。有効な値:

  • NextToken が空の場合、後続のクエリは存在しません。

  • NextToken が返された場合、その値は次のクエリのトークンを示します。

FFmyTO70tTpLG6I3FmYAXGKPd****

RequestId

string

リクエスト ID。

C46FF5A8-C5F0-4024-8262-B16B639225A0

TagResources

object

TagResource

array<object>

フィルター条件を満たすすべてのタグのリスト。

object

タグリスト。

TagValue

string

タグ値です。

FinanceJoshua

TagKey

string

タグキーです。

FinanceDept

成功レスポンス

JSONJSON

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 BothEmpty.TagsAndResources The specified Tags and ResourcesIds are not allow to both empty.
400 MissingParameter.TagKey The input parameter TagKey that is mandatory for processing this request is not supplied.
400 MissingParameter.TagValue The input parameter TagValue that is mandatory for processing this request is not supplied.
400 InvalidTagKey The tag keys are not valid.
400 InvalidTagValue The tag values are not valid.
400 MissingParam %s
400 InvalidInstanceType.NotFound The instance type is not found
400 InvalidInstanceIds.NotFound The instanceIds are not found
400 Forbidden.TagKeys The request do not allow to operate the tag keys
400 QuotaExceeded.TagNum Custom Tags quota exceeded
400 Forbidden.NotAllowedCategary The System tag is not valid
400 Forbidden.TagKey.Duplicated The specified tag key already exists.
400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded.
400 SizeLimitExceeded.ResourceId The maximum number of resource IDs is exceeded.
403 Forbidden User not authorized to operate on the specified resource.

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

変更履歴

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