ListVpcEndpointServicesByEndUser を使用して承認されたエンドポイントサービスをクエリ - PrivateLink - Alibaba Cloud - PrivateLink

ListVpcEndpointServicesByEndUser API を呼び出して、現在のアカウントがホワイトリストに登録されているエンドポイントサービスのリストを取得します。このリストには、新しいエンドポイントを作成して接続できるサービスに加え、既存のエンドポイントにすでに接続されているサービスも含まれます。

操作説明

今すぐお試しください

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

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#AccountId}:vpcendpointservice/*

privatelink:VpcEndpointServiceId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions API を呼び出して、リージョン ID を取得できます。	cn-huhehaote
NextToken	string	任意	ページネーショントークン。初回リクエストの場合、このパラメータは指定しないでください。追加の結果がある場合は、このパラメータを前回のレスポンスの NextToken の値に設定して、次のページを取得します。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	任意	各ページで返されるエントリ数。有効値： 1 ～ 1000。デフォルト値： 50。	50
ServiceId	string	任意	エンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	任意	エンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
ServiceType	string	任意	エンドポイントサービスのタイプ。 Interface のみサポートされています。インターフェイスエンドポイントを使用すると、サービスリソースとして Application Load Balancer (ALB)、Classic Load Balancer (CLB)、Network Load Balancer (NLB) を使用できます。	Interface
RegionId	string	必須	The region ID. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
Tag	array<object>	任意	リソースをフィルタリングするタグのリスト。最大 20 個のタグを指定できます。
	object	任意	タグを構成するキーと値のペア。
Key	string	任意	タグのキー。タグキーは空の文字列にできません。タグキーは最大 64 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることもできません。	FinanceDept
Value	string	任意	タグの値。タグ値は空の文字列にできます。タグ値は最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることもできません。	FinanceJoshua
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmy*****
ServiceRegionId	string	任意	エンドポイントサービスのリージョン ID。	cn-beijing

レスポンスフィールド

フィールド	型	説明	例
	object
Services	array<object>	エンドポイントサービスのリスト。
	array<object>	エンドポイントサービス。
Payer	string	支払者。有効値： Endpoint：サービスコンシューマー。 EndpointService：サービスプロバイダー。	Endpoint
ServiceDomain	string	エンドポイントサービスのドメイン名。	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Zones	array	エンドポイントサービスが利用可能なゾーンのリスト。
	string	エンドポイントサービスが利用可能なゾーン。	cn-huhehaote-a
ServiceId	string	エンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	エンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceType	string	エンドポイントサービスのタイプ。値は常に Interface です。これは、Application Load Balancer (ALB)、Classic Load Balancer (CLB)、Network Load Balancer (NLB) などのサービスリソースを追加できるインターフェイスエンドポイントであることを示します。	Interface
ServiceSupportIPv6	boolean	エンドポイントサービスが IPv6 をサポートするかどうかを示します。有効値： true：エンドポイントサービスは IPv6 をサポートします。 false：エンドポイントサービスは IPv6 をサポートしません。	false
Tags	array<object>	タグのリスト。
	object	タグ。
Key	string	タグキー。	FinanceDept
Value	string	タグ値。	FinanceJoshua
ResourceGroupId	string	リソースグループの ID。	rg-acfmy*****
ServiceResourceType	string	サービスリソースタイプ。 slb：Classic Load Balancer (CLB) インスタンス。 alb：Application Load Balancer (ALB) インスタンス。 nlb：Network Load Balancer (NLB) インスタンス。	slb
AddressIpVersion	string	IP バージョン。有効値： IPv4：サービスは IPv4 をサポートします。 DualStack：サービスは IPv4 と IPv6 の両方をサポートします (デュアルスタック)。	IPv4
ZoneAffinityEnabled	boolean	ゾーンアフィニティが有効かどうかを示します。有効値： true：ゾーンアフィニティは有効です。 false：ゾーンアフィニティは無効です。	false
VpcEndpointPolicySupported	boolean
AutoAcceptEnabled	boolean	接続リクエストを自動的に受け入れるかどうかを示します。有効値： true：接続リクエストは自動的に受け入れられます。 false：接続リクエストは手動で受け入れる必要があります。	true
NextToken	string	次のページの結果を取得するためのトークン。このパラメータが空の場合は、すべての結果が返されたことを示します。値が返された場合は、後続のリクエストでその値を使用して、次のページの結果を取得してください。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	ページごとに返されるエントリ数。	50
TotalCount	string	エントリの総数。	29

例

成功レスポンス

JSONJSON

{
  "Services": [
    {
      "Payer": "Endpoint",
      "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
      "Zones": [
        "cn-huhehaote-a"
      ],
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
      "ServiceType": "Interface",
      "ServiceSupportIPv6": false,
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "rg-acfmy*****",
      "ServiceResourceType": "slb",
      "AddressIpVersion": "IPv4",
      "ZoneAffinityEnabled": false,
      "VpcEndpointPolicySupported": false,
      "AutoAcceptEnabled": true
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": "29"
}

エラーコード

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

変更履歴

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