GA リソース向け ListTagResources API 概要 - Global Accelerator

Global Accelerator (GA) リソースに追加されたタグを照会します。

操作説明

照会するオブジェクトを指定するには、リクエストで ResourceId または Tag を指定する必要があります。********
Tag は、キーと値のペア (Key と Value) で構成されるリソースタグです。Key のみを指定した場合、指定されたタグキーに関連付けられているすべてのタグ値が返されます。Value のみを指定した場合は、エラーメッセージが返されます。
Tag と ResourceId を指定してタグをフィルター処理する場合、ResourceId は指定されたすべてのキーと値のペアに一致する必要があります。
複数のキーと値のペアを指定した場合、それらのキーと値のペアを含むリソースが返されます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ga:ListTagResources

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	GA インスタンスがデプロイされているリージョンの ID。値を cn-hangzhou に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側でトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。各リクエストのリクエスト ID は異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
NextToken	string	任意	次のクエリの開始点を決定するトークン。有効な値：最初のクエリで、後続のクエリがない場合は、このパラメーターを無視します。後続のクエリを送信する場合は、このパラメーターを前回の呼び出しで返された NextToken の値に設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****
ResourceType	string	必須	タグ情報を照会するリソースのタイプ。有効な値： accelerator：標準 GA インスタンス basicaccelerator：ベーシック GA インスタンス bandwidthpackage：帯域幅プラン acl：アクセス制御リスト (ACL) endpointgroup：エンドポイントグループ	accelerator
ResourceId	array	任意	タグ情報を照会するリソースの ID。 ResourceType を accelerator に設定した場合、ResourceId の値を標準 GA インスタンスの ID に設定します。 ResourceType を basicaccelerator に設定した場合、ResourceId の値をベーシック GA インスタンスの ID に設定します。 ResourceType を bandwidthpackage に設定した場合、ResourceId の値を帯域幅プランの ID に設定します。 ResourceType を acl に設定した場合、ResourceId の値を ACL の ID に設定します。 ResourceType を endpointgroup に設定した場合、ResourceId の値をエンドポイントグループの ID に設定します。最大 50 個の GA リソース ID を指定できます。
	string	任意	タグ情報を照会するリソースの ID。 ResourceType を accelerator に設定した場合、ResourceId の値を標準 GA インスタンスの ID に設定します。 ResourceType を basicaccelerator に設定した場合、ResourceId の値をベーシック GA インスタンスの ID に設定します。 ResourceType を bandwidthpackage に設定した場合、ResourceId の値を帯域幅プランの ID に設定します。 ResourceType を acl に設定した場合、ResourceId の値を ACL の ID に設定します。 ResourceType を endpointgroup に設定した場合、ResourceId の値をエンドポイントグループの ID に設定します。最大 50 個の GA リソース ID を指定できます。	ga-bp149u6o36qt1as9b****
Tag	array<object>	任意	GA リソースのタグの配列。最大 20 個のタグを指定できます。
	object	任意	GA リソースのタグ。最大 20 個のタグを指定できます。
Key	string	任意	GA リソースのタグキー。タグキーを空の文字列にすることはできません。タグキーは最大 64 文字で、`http://` または `https://` を含めることはできません。また、`aliyun` または `acs:` で始めることはできません。最大 20 個のタグキーを指定できます。	KeyTest
Value	string	任意	GA リソースのタグ値。タグ値は空の文字列にすることができます。タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。また、`aliyun` または `acs:` で始めることはできません。最大 20 個のタグ値を指定できます。	valueTest

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
TotalCount	integer	返されたエントリの数。	1
NextToken	string	次のクエリの開始点を決定するトークン。有効な値： NextToken が空の場合、後続のクエリがないことを示します。 NextToken に値が返された場合、その値が次のクエリの開始点を決定するトークンになります。	FFmyTO70tTpLG6I3FmYAXGKPd****
TagResources	object
TagResource	array<object>	タグが追加されたリソースに関する情報。
	object	タグが追加されたリソースに関する情報。
ResourceType	string	リソースのタイプ。 accelerator：標準 GA インスタンス basicaccelerator：ベーシック GA インスタンス bandwidthpackage：帯域幅プラン acl：ACL endpointgroup：エンドポイントグループ	accelerator
TagValue	string	タグ値。	KeyTest
ResourceId	string	リソースの ID。	ga-bp149u6o36qt1as9b****
TagKey	string	タグキー。	valueTest

例

成功レスポンス

JSONJSON

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "accelerator",
        "TagValue": "KeyTest",
        "ResourceId": "ga-bp149u6o36qt1as9b****",
        "TagKey": "valueTest"
      }
    ]
  }
}

エラーコード

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

変更履歴

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