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

リソースにバインドされているタグを照会します。

操作説明

リクエストで ResourceId.N または Tag.N (Tag.N.Key および Tag.N.Value) の少なくとも一方を指定して、クエリ対象を決定してください。
Tag.N はリソースのタグであり、キーと値のペアで構成されます。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	任意	リソースのタグキー。最大 20 個のタグキーを指定できます。このパラメーターを指定する場合、値は空文字列にできません。タグキーの長さは最大 64 文字です。英字または漢字で始まる必要があり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	FinanceDept
Value	string	任意	リソースのタグ値。最大 20 個のタグ値を指定できます。このパラメーターを指定する場合、値は空文字列にできます。タグ値の長さは最大 128 文字です。英字または漢字で始まる必要があり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	FinanceJoshua
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。異なるリクエスト間で値が一意になるように、クライアント側でパラメーター値を生成してください。ClientToken は ASCII 文字のみをサポートします。	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	必須	リソースのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
NextToken	string	任意	次のクエリトークンが利用可能かどうかを指定します。有効な値: これが最初のクエリであるか、次のクエリが利用できない場合は、このパラメーターを指定する必要はありません。次のクエリが利用可能な場合は、前の API 呼び出しで返された NextToken の値を設定します。	caeba0bbb2be03f84eb48b699f0a****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	8D8992C1-6712-423C-BAC5-E5E817484C6B
TagResources	array<object>	タグがバインドされているリソースの情報。
	object	タグがバインドされているリソースの情報。
TagKey	string	タグキー。	エンドポイント
TagValue	string	タグ値。	FinanceJoshua
ResourceId	string	リソースの ID。	ep-hp3i05294c2d2d******
ResourceType	string	リソースタイプ。有効な値: vpcendpoint: エンドポイント。 vpcendpointservice: エンドポイントサービス。	vpcendpoint
NextToken	string	次のクエリトークンが利用可能かどうかを指定します。有効な値: これが最初のクエリであるか、次のクエリが利用できない場合は、このパラメーターを指定する必要はありません。次のクエリが利用可能な場合は、前の API 呼び出しで返された 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.

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

変更履歴

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