ListTagResources でリソースタグをクエリ - PrivateLink

リソースに追加されたタグを照会します。

操作説明

照会するオブジェクトを指定するには、リクエストで ResourceId.N または Tag.N を指定する必要があります。
Tag.N は、キーと値のペア (Tag.N.Key と Tag.N.Value) で構成されるリソースタグです。Tag.N.Key のみを指定した場合、指定されたキーに関連付けられているすべてのタグ値が返されます。Tag.N.Value のみ指定した場合は、エラーメッセージが返されます。
Tag.N と ResourceId.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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

privatelink:ListTagResources

get

*VpcEndpoint

acs:privatelink:*:{#accountId}:vpcendpoint/{#vpcendpointId}

*VpcEndpointService

acs:privatelink:*:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceId	array	任意	リソース ID。最大 50 個のリソース ID を指定できます。
	string	任意	リソース ID。	ep-hp3i05294c2d2d******
ResourceType	string	必須	リソースのタイプ。有効な値： vpcendpoint：エンドポイント vpcendpointservice：エンドポイントサービス	vpcendpoint
Tag	array<object>	任意	リソースに追加するタグ。
	object	任意	リソースに追加するタグ。
Key	string	任意	リソースに追加するタグ N のキー。最大 20 個のタグキーを指定できます。タグキーを空の文字列にすることはできません。タグキーは、最大 64 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。タグキーは文字で始まる必要があり、`aliyun` または `acs:` で始めることはできません。タグキーに `http://` または `https://` を含めることはできません。	FinanceDept
Value	string	任意	リソースに追加するタグ N の値。最大 20 個のタグ値を指定できます。タグ値は空の文字列にすることができます。タグ値は、最大 128 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。タグ値は文字で始まる必要があり、`aliyun` または `acs:` で始めることはできません。タグ値に `http://` または `https://` を含めることはできません。	FinanceJoshua
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	必須	リソースが所在するリージョンの ID です。DescribeRegions 操作を呼び出すと、最新のリージョンリストを照会できます。	cn-hangzhou
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。これが最初のリクエストであるか、次のリクエストを送信しない場合は、このパラメーターを指定する必要はありません。次のリクエストを送信する場合は、前のリクエストから取得したトークンを NextToken の値として指定する必要があります。	caeba0bbb2be03f84eb48b699f0a****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	8D8992C1-6712-423C-BAC5-E5E817484C6B
TagResources	array<object>	タグが追加されたリソース。
	object	タグが追加されたリソース。
TagKey	string	リソースに追加されたタグ N のキー。	endpoint
TagValue	string	リソースに追加されたタグ N の値。	FinanceJoshua
ResourceId	string	リソース ID。	ep-hp3i05294c2d2d******
ResourceType	string	リソースのタイプ。有効な値： vpcendpoint：エンドポイント vpcendpointservice：エンドポイントサービス	vpcendpoint
NextToken	string	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。有効な値：これが最初のリクエストであり、次のリクエストを実行しない場合は、このパラメーターを指定する必要はありません。次のリクエストを実行する場合は、最後の呼び出しから返された NextToken の値をパラメーターに設定します。	caeba0bbb2be03f84eb48b699f0a4883

例

成功レスポンス

JSONJSON

{
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "TagResources": [
    {
      "TagKey": "endpoint",
      "TagValue": "FinanceJoshua",
      "ResourceId": "ep-hp3i05294c2d2d******",
      "ResourceType": "vpcendpoint"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	DuplicatedTagKey	The tag keys is duplicated.
400	MissingTagKeyParam	The tag key is empty.
400	MissingTagValueParam	The tag value is empty.
400	MissingResourceIdOrTagParam	The resource id and tag is empty.
400	IllegalTagKeyParam	IllegalTagKeyParam
400	IllegalTagValueParam	The tag value is Illegal.

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

変更履歴

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