DescribeLoadBalancers で ELB インスタンスを查询 - ENS

ご利用のロードバランサーインスタンスのリストを取得します。

操作説明

API 呼び出しレート：100 リクエスト/秒。
ユーザーごとの呼び出しレート：10 リクエスト/秒。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeLoadBalancers

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnsRegionId	string	任意	Edge Node Service (ENS) ノードの ID。	cn-guangzhou-10
ServerId	string	任意	バックエンドサーバーの ID。	i-5f67ffjc004wwz0t****
LoadBalancerStatus	string	任意	ロードバランサーのステータス。有効な値： Active：インスタンスのリスナーは、ルールに基づいて受信トラフィックを転送します。 Inactive：インスタンスのリスナーは、受信トラフィックを転送しなくなります。	InActive
LoadBalancerId	string	任意	ロードバランサーインスタンスの ID。	lb-5q73cv04zeyh43lh74lp4****
LoadBalancerName	string	任意	ロードバランサーインスタンスの名前。	example
NetworkId	string	任意	ネットワークの ID。	n-5s9ayrxsd9hszrlt5fgv2****
VSwitchId	string	任意	vSwitch の ID。	vsw-5sy773iy25rulsmgskmba****
Address	string	任意	ロードバランサーインスタンスのサービスアドレス。	10.0.XX.XX
EnsRegionIds	array	任意	ENS ノード ID のリスト。
	string	任意	ENS ノードの ID。	cn-chengdu-telecom-4
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。有効な値：10～100。デフォルト値：10。	100
LoadBalancerType	string	任意	ロードバランサーインスタンスのタイプ。

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	ページ番号。	1
PageSize	integer	ページあたりのエントリ数。デフォルト値は 10 です。有効な値：10～100。	100
TotalCount	integer	返されたエントリの総数。	1
LoadBalancers	object	ELB インスタンスのリスト。
LoadBalancer	array<object>	ELB インスタンスのリスト。
	object	ELB インスタンスの詳細。
LoadBalancerId	string	ELB インスタンスの ID。	lb-5snthcyu1x10g7tywj7iu****
LoadBalancerName	string	ELB インスタンスの名前。	example
LoadBalancerStatus	string	ELB インスタンスのステータス。有効な値： Active：インスタンスのリスナーは、ルールに基づいて受信したトラフィックを転送できます。 Inactive：インスタンスのリスナーは、受信したトラフィックを転送しなくなります。	InActive
Address	string	ELB インスタンスのサービスアドレス。	10.10.XX.XX
EnsRegionId	string	ENS ノードの ID。	cn-wuhan-telecom
NetworkId	string	ネットワークの ID。	n-5rz0rj1caexauilpsjx0w****
VSwitchId	string	vSwitch の ID。	vsw-5rllcjb3ol6duzjdnbm1om****
CreateTime	string	ELB インスタンスが作成された時刻。時刻は協定世界時 (UTC) で表示されます。	2021-05-06T11:13:41Z
AddressIPVersion	string	IP バージョン。有効な値：ipv4 および ipv6。	ipv4
PayType	string	インスタンスの課金方法。有効な値： PrePaid：サブスクリプション PostPaid：従量課金。現在サポートされているのは、この課金方法のみです。	PostPaid
LoadBalancerType	string	ELB インスタンスのタイプ。
AddressType	string	アドレスタイプ。

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
        "LoadBalancerName": "example",
        "LoadBalancerStatus": "InActive",
        "Address": "10.10.XX.XX",
        "EnsRegionId": "cn-wuhan-telecom",
        "NetworkId": "n-5rz0rj1caexauilpsjx0w****",
        "VSwitchId": "vsw-5rllcjb3ol6duzjdnbm1om****",
        "CreateTime": "2021-05-06T11:13:41Z",
        "AddressIPVersion": "ipv4",
        "PayType": "PostPaid",
        "LoadBalancerType": "",
        "AddressType": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.

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

変更履歴

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