edit-icon download-icon

DescribeLoadBalancers

最終更新日: May 05, 2018

説明

すべての LoadBalancer リストを照会します。

LoadBalancerId、AddressType、InternetChargeType、ServerId などのパラメータをクエリ条件として使用できます。前述の問合せ基準のいずれもフィルタとして使用されない場合、ユーザーが所有するすべての LoadBalancers が戻されます。

リクエストパラメータ

名前 必須かどうか 説明
Action String はい システムで指定されている操作インターフェースの名前。値: DescribeLoadBalancers.
RegionId String はい Server Load Balancer インスタンスが配置されている Region の ID。
LoadBalancerId String いいえ Server Load Balancer インスタンス ID はフィルタとして使用され、複数値のクエリがサポートされます。値:複数のパラメータを入力し、”、”で区切ることができます。デフォルト:なし。パラメータが設定されていない場合は、パラメータがフィルタ条件として使用されていないことを意味します。
LoadBalancerName String いいえ Server Load Balancer インスタンスの名前はフィルタとして使用され、複数値のクエリがサポートされます。値:複数のパラメータを入力し、”、”で区切ることができます。デフォルト:なし。パラメータが設定されていない場合は、パラメータがフィルタ条件として使用されていないことを意味します。
AddressType String いいえ アドレス型はフィルタとして使用されます。値: インターネット/イントラネット。デフォルト:なし。パラメータが設定されていない場合は、パラメータがフィルタ条件として使用されていないことを意味します。
NetworkType String いいえ パブリックネットワークインスタンスの充電モードはフィルタとして使用されます。
VpcId String いいえ Server Load Balancer インスタンスの VPC ID。

値: wrr/wlc

デフォルト: wrr.

VswitchId String いいえ Server Load Balancer インスタンスの Vswitchid。
Address String いいえ Server Load Balancer インスタンスのサービスアドレス。
InternetChargeType String いいえ パブリックネットワークインスタンスの充電モードはフィルタとして使用されます。値: paybybandwidth / paybytrafficデフォルト:なし。パラメータが設定されていない場合は、パラメータがフィルタ条件として使用されていないことを意味します。
ServerId String いいえ バックエンドサーバー ID(ECS インスタンス ID)はフィルターとして使用されます。基準を採用すると、このサーバーに接続されている Server Load Balancer インスタンスのみが返されます。値:ECS インスタンスの ID。デフォルト: なし。パラメータが設定されていない場合は、パラメータがフィルタ条件として使用されていないことを意味します。
MasterZoneId String いいえ インスタンスのマスターゾーン ID。DescribeZonesを使用して、あるリージョンのマスター/スレーブゾーンを表示します。Fincloud ではマルチゾーンがサポートされていません。
SlaveZoneId String いいえ インスタンスのスレーブゾーン ID。DescribeZone を使用して、あるリージョンのマスター/スレーブゾーンを表示します。Fincloud ではマルチゾーンがサポートされていません。
Tags String いいえ 追加されるタグリスト。値: Json 文字列、構造体は JsonList です。リクエストでは、List 内の要素の最大数は 10 です。List 要素の構造は次のとおりです。

リターンパラメータ

名前 説明
Common Parameter 詳細は、共通パラメーターを参照してください。
LoadBalancers List Server Load Balancer インスタンスのリストが配列形式で返されます。次の表を参照してください。

Server Load Balancer インスタンスリスト(LoadBalancers)

名前 説明
LoadBalancerId String Server Load Balancer インスタンスの一意の ID。
LoadBalancerName String Server Load Balancer インスタンスの別名
LoadBalancerStatus String Server Load Balancer インスタンスのステータス(非アクティブ、アクティブまたはロック)。 ロックされた状態は、インスタンスが Alibaba Cloud によって滞留またはロックされていることを示します。更新するか、Alibaba Cloud に連絡してロックを解除してください。
Address String SLB インスタンスのサービスアドレス。
RegionId String リージョンの ID。
RegionIdAlias String リージョンのエイリアス。DescribeRegions の return パラメータと同じです。
AddressType String SLB インスタンスの型 。
VSwitchId String SLB インスタンスの VSwitch ID。
VpcId String SLB インスタンスの VPC ID。
NetworkType String SLB インスタンスのネットワーク型 。VPC またはクラシック。
Bandwidth String パブリックネットワークインスタンスが固定帯域幅で充電されるときに設定されるピーク帯域幅。
CreateTime String SLB インスタンスの作成時間。
MasterZoneId String インスタンスのマスターゾーン ID。
SlaveZoneId String インスタンスのスレーブゾーン ID。

リクエストの例

  1. https://slb.aliyuncs.com/
  2. &Action=DescribeLoadBalancers
  3. &RegionId=cn-east-hangzhou-01
  4. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01, 282b00102ac-cn-east-hangzhou-01&<common request parameter>

リターンの例

  • XML 形式

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeLoadBalancersResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <LoadBalancers>
    5. <LoadBalancer>
    6. <LoadBalancerId>139a00604ad-cn-east-hangzhou-01</LoadBalancerId>
    7. <LoadBalancerName>abc</LoadBalancerName>
    8. <Address>100.98.28.56</Address>
    9. <AddressType>intranet</AddressType>
    10. <RegionId>cn-east-hangzhou-01</RegionId>
    11. <VSwitchId>vsw-255ecrwq4</VSwitchId>
    12. <VpcId>vpc-25dvzy9f9</VpcId>
    13. <NetworkType>vpc</NetworkType>
    14. <LoadBalancerStatus>active</LoadBalancerStatus>
    15. </LoadBalancer>
    16. <LoadBalancer>
    17. <LoadBalancerId>282b00102ac-cn-east-hangzhou-01</LoadBalancerId>
    18. <LoadBalancerName>def</LoadBalancerName>
    19. <Address>100.98.28.55</Address>
    20. <AddressType>intranet</AddressType>
    21. <RegionId>cn-east-hangzhou-01</RegionId>
    22. <VSwitchId>vsw-255ecrwq5</VSwitchId>
    23. <VpcId>vpc-25dvzy9f8</VpcId>
    24. <NetworkType>vpc</NetworkType>
    25. <LoadBalancerStatus>active</LoadBalancerStatus>
    26. </LoadBalancer>
    27. </LoadBalancers>
    28. </DescribeLoadBalancersResponse>
  • JSON 形式

    1. {
    2. "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "LoadBalancers": {
    4. "LoadBalancer": [
    5. {
    6. "LoadBalancerId": "139a00604ad-cn-east-hangzhou-01",
    7. "LoadBalancerName": "abc",
    8. "Address": "100.98.28.56",
    9. "AddressType": "intranet",
    10. "RegionId": "cn-east-hangzhou-01",
    11. "VSwitchId": "vsw-255ecrwq4",
    12. "VpcId": "vpc-25dvzy9f9",
    13. "NetworkType": "vpc",
    14. "LoadBalancerStatus ": "active"
    15. },
    16. {
    17. "LoadBalancerId": "282b00102ac-cn-east-hangzhou-01",
    18. "LoadBalancerName": "def",
    19. "Address": "100.98.28.55",
    20. "AddressType": "intranet",
    21. "RegionId": "cn-east-hangzhou-01",
    22. "VSwitchId": "vsw-255ecrwq5",
    23. "VpcId": "vpc-25dvzy9f8",
    24. "NetworkType": "vpc",
    25. "LoadBalancerStatus ": "active"
    26. }
    27. ]
    28. }
    29. }