ListVpcEndpointSecurityGroups による VPC エンドポイントセキュリティグループの一覧表示 - PrivateLink

今すぐお試しください

この 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:ListVpcEndpointSecurityGroups

get

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	クエリ対象のエンドポイントが属するリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-huhehaote
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。有効な値は次のとおりです：初回のリクエストで、後続のリクエストを実行しない場合は、このパラメーターを指定する必要はありません。後続のリクエストを実行する場合は、このパラメーターを前回の呼び出しで返された NextToken の値に設定します。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	任意	各ページに返すエントリ数。有効値：1～50。デフォルト値：50。	50
EndpointId	string	必須	クエリ対象のエンドポイントの ID。	ep-hp33b2e43fays7s8****
RegionId	string	必須	クエリ対象のエンドポイントが属するリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-huhehaote

レスポンスフィールド

フィールド	型	説明	例
	object
SecurityGroups	array<object>	セキュリティグループに関する情報。
	object	配列オブジェクトに関する情報。
SecurityGroupId	string	エンドポイントに関連付けられているセキュリティグループの ID。	sg-hp33bw6ynvm2yb0e****
SecurityGroupStatus	string	セキュリティグループの関連付けステータス。有効な値は次のとおりです： Attaching：セキュリティグループはアタッチ中です。 Attached：セキュリティグループはアタッチ済みです。 Detaching：セキュリティグループはデタッチ中です。	Attached
NextToken	string	返された NextToken の値はページネーショントークンであり、次のリクエストで結果の新しいページを取得するために使用できます。有効な値は次のとおりです： NextToken の値が返されない場合、後続のリクエストは実行されません。 NextToken の値が返された場合、その値を次のリクエストで使用して、結果の新しいページを取得できます。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	リクエスト ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	1ページあたりに返されるエントリ数。	50
TotalCount	integer	返されたエントリの総数。	12

例

成功レスポンス

JSONJSON

{
  "SecurityGroups": [
    {
      "SecurityGroupId": "sg-hp33bw6ynvm2yb0e****",
      "SecurityGroupStatus": "Attached"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	EndpointNotFound	The specified Endpoint does not exist.

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

変更履歴

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