DescribeLoadBalancers

Description

作成したロードバランサーの詳細情報を取得します。

ロードバランサーを指定した場合には、指定したロードバランサーの詳細情報を取得します。

ロードバランサーを省略した場合には、本APIを発行したアカウントのプロジェクトに属するアカウントが作成したロードバランサーの詳細情報を取得します。

Request Parameters

すべての動作で使用する一般的なパラメタの情報に関しては、「Common Parameters」を参照してください。

  • LoadBalancerNames.member.N

    アカウントが属するプロジェクト内のアカウントが作成したロードバランサーのリスト。

    • Type: String list
    • Required: No
  • Marker

    予約パラメータ。

    • Type: String
    • Required: No

Response

以下のステータスコードを返却します。

  • Normal response code

    本動作は正常に受け付けられました。

    • HTTP Status Code: 200

Response Elements

DescribeLoadBalancersResultという構造体で、以下の要素を返却します。

  • LoadBalancerDescriptions

    ロードバランサーの詳細情報のリスト。

  • NextMarker

    予約パラメータ

    • Type: String

Errors

すべての動作に共通のエラー情報に関しては、「Common Errors」を参照してください。

  • AccessPointNotFound

    指定したロードバランサーが見つかりませんでした。

    • HTTP Status Code: 400

Examples

Sample Request

この例では、ロードバランサー名がMyLB01のロードバランサーの詳細情報を取得します。


       https://loadbalancing.(リージョン名).cloud.global.fujitsu.com/?LoadBalancerNames.member.1=MyLB01
       &Version=2014-11-01
       &Action=DescribeLoadBalancers  
       

Sample Response (XML)


       <DescribeLoadBalancersResponse xmlns=" http://docs.cloudcommunity.global.fujitsu.com/loadbalancing/api/v1.0">
        <DescribeLoadBalancersResult>
         <LoadBalancerDescriptions>
          <member>
           <LoadBalancerName>MyLB01</LoadBalancerName>
           <DNSName>MyLB01-3b9c2b0f028f40e09d6306887646c28b.loadbalancing-jp-east-1.cloud.global.fujitsu.com</DNSName>
           <State>InService</State>
           <ListenerDescriptions>
            <member>
             <Listener>
              <Protocol>HTTPS</Protocol>
              <LoadBalancerPort>443</LoadBalancerPort>
              <InstanceProtocol>HTTP</InstanceProtocol>
              <InstancePort>80</InstancePort>
              <SSLCertificateId>1232d7bf-8f28-4cc7-a63d-44e218853c6d</SSLCertificateId>
             </Listener>
             <PolicyNames>
              <member>MyPolicy</member>
             </PolicyNames>
            </member>
           </ListenerDescriptions>
           <Policies>
            <LBCookieStickinessPolicies>
             <member>
              <PolicyName>MyLoadBalancerCookieStickinessPolicy</PolicyName>
              <CookieExpirationPeriod>60</CookieExpirationPeriod>
             </member>
            </LBCookieStickinessPolicies>
            <OtherPolicies>
             <member>
              <PolicyName>MyPolicy</PolicyName>
             </member>
            </OtherPolicies>
           </Policies>
           <Subnets>
            <member>MySubnet</member>
           </Subnets>
           <Instances>
            <member>
             <InstanceId>i-e4cbe38d</InstanceId>
             <PortId>p-e4cbe38d</PortId>
            </member>
           </Instances>
           <HealthCheck>
            <Target>HTTP:80</Target>
            <Interval>90</Interval>
            <Timeout>60</Timeout>
            <UnhealthyThreshold>10</UnhealthyThreshold>
            <HealthyThreshold>2</HealthyThreshold>
           </HealthCheck>
           <SecurityGroups>
            <member>MySecurityGroup</member>
           </SecurityGroups>
           <CreatedTime>2014-06-01T21:15:31.280Z</CreatedTime>
            <Scheme>Internal</Scheme>
            <Grade>Standard</Grade>
          </member>
         </LoadBalancerDescriptions>
         <NextMarker></NextMarker>
        </DescribeLoadBalancersResult>
        <ResponseMetadata>
         <requestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</requestId>
        </ResponseMetadata>
       </DescribeLoadBalancersResponse>
     

Sample Response (JSON)


       {
        "DescribeLoadBalancersResponse": {
         "DescribeLoadBalancersResult": {
          "LoadBalancerDescriptions": {
           "member": [
            {
             "LoadBalancerName": "MyLB01",
             "DNSName": "MyLB01-3b9c2b0f028f40e09d6306887646c28b.loadbalancing-jp-east-1.cloud.global.fujitsu.com",
             "State": "InService",
             "ListenerDescriptions": {
              "member": [
               {
                "Listener": {
                 "Protocol": "HTTPS",
                 "LoadBalancerPort": "443",
                 "InstanceProtocol": "HTTP",
                 "InstancePort": "80",
                 "SSLCertificateId": "1232d7bf-8f28-4cc7-a63d-44e218853c6d"
                },
                "PolicyNames": [
                 {
                  "member": "MyPolicy"
                 }
                ]
               }
              ]
             },
             "Policies": {
              "LBCookieStickinessPolicies": {
               "member": [
                {
                 "PolicyName": "MyLoadBalancerCookieStickinessPolicy",
                 "CookieExpirationPeriod": "60"
                }
               ]
              },
              "OtherPolicies": {
               "member": [
                {
                 "PolicyName": "MyPolicy"
                }
               ]
              }
             },
             "Subnets": [
              {
               "member": "MySubnet"
              }
             ],
             "Instances": {
              "member": [
               {
                "InstanceId": "i-e4cbe38d",
                "PortId": "p-e4cbe38d"
               }
              ]
             },
             "HealthCheck": {
              "Target": "HTTP:80",
              "Interval": "90",
              "Timeout": "60",
              "UnhealthyThreshold": "10",
              "HealthyThreshold": "2"
             },
             "SecurityGroups": [
              {
               "member": "MySecurityGroup"
              }
             ],
             "CreatedTime": "2014-06-01T21:15:31.280Z",
             "Scheme": "Internal",
             "Grade": "Standard"
            }
           ]
          }
         },
         "ResponseMetadata": {
          "requestId": "83c88b9d-12b7-11e3-8b82-87b12EXAMPLE"
         }
        }
       }