ListTagResources API による ESA サイトタグのクエリ - ESA - Alibaba Cloud - Edge Security Acceleration

リージョン ID とリソースタイプでタグを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:ListTagResources

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。有効な値: Alibaba Cloud 中国サイト (www.aliyun.com): cn-hangzhou Alibaba Cloud 国際サイト (www.alibabacloud.com): ap-southeast-1。	cn-hangzhou
ResourceId	array	任意	リソース ID。サイト ID または DNS レコード ID を入力します。ResourceId と Tag のうち少なくとも 1 つを指定する必要があります。
	string	任意	リソース ID。サイト ID または DNS レコード ID を入力します。	123456xxxxx
Tag	array<object>	任意	タグのリスト。最大 20 個のタグを指定できます。ResourceId と Tag のうち少なくとも 1 つを指定する必要があります。
	object	任意	タグのリスト。最大 20 個のタグを指定できます。
Key	string	任意	タグキー。	env
Value	string	任意	タグ値。	value
ResourceType	string	必須	リソースタイプ。有効な値: site: サイト record: DNS レコード。	site
NextToken	string	任意	次のクエリでより多くの結果を返すためのトークン。説明最初のクエリではこのパラメーターを指定する必要はありません。クエリがすべての結果を返さない場合、前のクエリから返された NextToken 値を渡してクエリを続行します。	AAAAAZjtYxxxxxxxx
MaxItem	integer	任意	返すエントリの最大値。	20

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
NextToken	string	次のクエリのトークン。NextToken が空の場合、すべての情報が現在のページに表示されています。	AAAAAYwsxxxxxxx
TagResources	array<object>	リソースタグ。
	object	リソースタグ。
TagKey	string	タグキー。	env
TagValue	string	タグ値。	value
ResourceId	string	リソース ID。サイト ID または DNS レコード ID を入力します。	example.com
ResourceType	string	リソースタイプ。有効な値: site: サイト record: DNS レコード。	site
TotalCount	integer	エントリの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "CB1A380B-09F0-41BB-280B-72F8FD6DA2FE",
  "NextToken": "AAAAAYwsxxxxxxx",
  "TagResources": [
    {
      "TagKey": "env",
      "TagValue": "value",
      "ResourceId": "example.com",
      "ResourceType": "site"
    }
  ],
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.TagValue	The specified TagValue is invalid.
400	InvalidNextToken	The specified parameter NextToken is invalid.
404	InvalidResourceId.NotFound	The specified resource does not exist or is released.

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

変更履歴

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