ListVpcEndpointServices API の呼び出しによるエンドポイントサービスのクエリ - PrivateLink - Alibaba Cloud - PrivateLink

ListVpcEndpointServices オペレーションを呼び出して、自身のアカウントのエンドポイントサービスをクエリします。

今すぐお試しください

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

get

*VpcEndpointService

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	エンドポイントサービスがデプロイされているリージョンの ID です。 DescribeRegions API を呼び出して、リージョン ID を取得してください。	cn-huhehaote
NextToken	string	任意	次のクエリのページネーショントークンです。有効な値：最初のクエリの場合、またはこれ以上結果がない場合は、このパラメーターを空のままにしてください。別のクエリが必要な場合は、このパラメーターを、前の API 呼び出しで返された NextToken 値に設定してください。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	任意	1 ページあたりに返すエントリ数です。有効値：1～1000。デフォルト値：50。	50
ServiceId	string	任意	エンドポイントサービスの ID です。	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	任意	エンドポイントサービスの名前です。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ResourceId	string	任意	サービスリソースの ID です。	lb-hp32z1wp5peaoox2q****
ServiceResourceType	string	任意	サービスリソースのタイプです。有効な値： slb：サービスリソースは Classic Load Balancer (CLB) インスタンスです。 alb：サービスリソースは Application Load Balancer (ALB) インスタンスです。 nlb：サービスリソースは Network Load Balancer (NLB) インスタンスです。 gwlb：サービスリソースは Gateway Load Balancer (GWLB) インスタンスです。	slb
AutoAcceptEnabled	boolean	任意	エンドポイント接続を自動的に受け入れるかどうかを指定します。有効な値： true：エンドポイント接続を自動的に受け入れます。 false：エンドポイント接続を自動的に受け入れません。	false
ServiceStatus	string	任意	エンドポイントサービスのステータスです。有効な値： Creating：エンドポイントサービスは作成中です。 Pending：エンドポイントサービスは変更中です。 Active：エンドポイントサービスはアクティブです。 Deleting：エンドポイントサービスは削除中です。	Active
ServiceBusinessStatus	string	任意	エンドポイントサービスのビジネスステータスです。有効な値： Normal：エンドポイントサービスは正常です。 FinancialLocked：支払い遅延のため、エンドポイントサービスはロックされています。	Normal
ZoneAffinityEnabled	boolean	任意	名前解決でゾーンアフィニティを有効にするかどうかを指定します。有効な値： true：有効にします。 false：無効にします。	true
RegionId	string	必須	The ID of the region where the endpoint service is deployed. Call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
Tag	array<object>	任意	タグのリストです。
	object	任意	タグです。
Key	string	任意	インスタンスのタグキーです。最大 20 個のタグキーを指定できます。キーを空の文字列にすることはできません。キーの長さは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	FinanceDept
Value	string	任意	インスタンスのタグ値です。最大 20 個のタグ値を指定できます。値は空の文字列にすることができます。値の長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	FinanceJoshua
ResourceGroupId	string	任意	リソースグループの ID です。	rg-acfmy*****
AddressIpVersion	string	任意	IP アドレスバージョンです。有効な値： IPv4：IPv4 です。 DualStack：デュアルスタックです。	IPv4

レスポンスフィールド

フィールド	型	説明	例
	object
Services	array<object>	エンドポイントサービスの一覧。
	array<object>	エンドポイントサービスのコレクション。
AutoAcceptEnabled	boolean	エンドポイント接続を自動的に承諾するかどうかを示します。有効な値： true：エンドポイント接続を自動的に承諾します。 false：エンドポイント接続を自動的に承諾しません。	true
ServiceId	string	エンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
CreateTime	string	エンドポイントサービスが作成された時刻。	2021-09-24T17:15:10Z
MinBandwidth	integer	エンドポイント接続の最小帯域幅。単位：Mbps。	100
MaxBandwidth	integer	エンドポイント接続の最大帯域幅。単位：Mbps。	1024
ServiceStatus	string	エンドポイントサービスのステータス。有効な値： Creating：エンドポイントサービスは作成中です。 Pending：エンドポイントサービスは変更中です。 Active：エンドポイントサービスはアクティブです。 Deleting：エンドポイントサービスは削除中です。	Active
ZoneAffinityEnabled	boolean	ゾーンアフィニティが有効かどうか。有効な値： true：有効です。 false：無効です。	true
RegionId	string	エンドポイントサービスがデプロイされているリージョンのID。	cn-huhehaote
ServiceDomain	string	エンドポイントサービスのドメイン名。	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Payer	string	支払者。有効な値： Endpoint：サービスコンシューマー。 EndpointService：サービスプロバイダー。	Endpoint
ServiceBusinessStatus	string	エンドポイントサービスのビジネスステータス。有効な値： Normal：エンドポイントサービスは正常です。 FinancialLocked：延滞ロック。	Normal
ConnectBandwidth	integer	デフォルトの最大帯域幅。単位：Mbps。	1024
ServiceName	string	エンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceDescription	string	エンドポイントサービスの説明。	This is my EndpointService.
ServiceResourceType	string	サービスリソースのタイプ。有効な値： slb：サービスリソースは CLB インスタンスです。 alb：サービスリソースは ALB インスタンスです。 nlb：サービスリソースは NLB インスタンスです。 gwlb：サービスリソースは GWLB インスタンスです。	slb
ServiceType	string	エンドポイントサービスのタイプ。有効な値： Interface：インターフェイスエンドポイント。CLB、ALB、NLB インスタンスをサービスリソースとして追加できます。 GatewayLoadBalancer：Gateway Load Balancer エンドポイント。GWLB インスタンスをサービスリソースとして追加できます。	Interface
ServiceSupportIPv6 `deprecated`	boolean	エンドポイントサービスが IPv6 をサポートしているかどうか。有効な値： true：サポートしています。 false：サポートしていません。	false
Tags	array<object>	タグのリスト。
	object	タグのリスト。
Key	string	インスタンスのタグキー。	FinanceDept
Value	string	インスタンスのタグ値。	FinanceJoshua
ResourceGroupId	string	リソースグループの ID。	rg-acfmy*****
AddressIpVersion	string	IP アドレスバージョン。有効な値： IPv4：IPv4。 DualStack：デュアルスタック。	IPv4
SupportedRegionSet	array<object>	エンドポイントサービスでサポートされているリージョンのリスト。サービスコンシューマーは、これらのリージョンからエンドポイント接続を開始できます。
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string	エンドポイントサービスでサポートされているリージョンのステータス。有効な値： Pending：ステータスは更新中です。 Available：リージョンは利用可能です。 Deleting：リージョンは削除中です。 Failed：操作は失敗しました。 Closed：リージョンはクローズされています。	Available
RegionBusinessStatus	string	エンドポイントサービスでサポートされているリージョンのビジネスステータス。有効な値： Normal：正常。 FinancialLocked：延滞ロック。	Normal
SupportedRegionId	string	エンドポイントサービスでサポートされているリージョンの ID。	cn-hangzhou
NextToken	string	次のクエリのページネーショントークン。有効な値： NextToken が空の場合、それ以上結果はありません。 NextToken に値がある場合は、次のクエリの開始トークンとして使用します。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	1 ページあたりに返されるエントリ数。	50
TotalCount	integer	レコードの総数。	12

例

成功レスポンス

JSONJSON

{
  "Services": [
    {
      "AutoAcceptEnabled": true,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "CreateTime": "2021-09-24T17:15:10Z",
      "MinBandwidth": 100,
      "MaxBandwidth": 1024,
      "ServiceStatus": "Active",
      "ZoneAffinityEnabled": true,
      "RegionId": "cn-huhehaote",
      "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
      "Payer": "Endpoint",
      "ServiceBusinessStatus": "Normal",
      "ConnectBandwidth": 1024,
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
      "ServiceDescription": "This is my EndpointService.",
      "ServiceResourceType": "slb",
      "ServiceType": "Interface",
      "ServiceSupportIPv6": false,
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "rg-acfmy*****",
      "AddressIpVersion": "IPv4",
      "SupportedRegionSet": [
        {
          "ServiceRegionId": "",
          "RegionServiceStatus": "Available",
          "RegionBusinessStatus": "Normal",
          "SupportedRegionId": "cn-hangzhou"
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

エラーコード

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

変更履歴

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