DescribeLoadBalancers

Description

Retrieves detailed information of the created load balancer.

If a load balancer is specified, the call describes the specified load balancer.

If no load balancers are specified, the call describes the load balancers created using an account belonging to the same project as the account that issued this API.

Request Parameters

Refer to "Common Parameters" for details on standard parameter information used by all actions.

• LoadBalancerNames.member.N

  List of load balancers created by an account belonging to the project.

  • Type: String list
  • Required: No
• Marker

  Reserved parameter.

  • Type: String
  • Required: No

Response

The following status code is returned.

• Normal response code

  This operation was accepted normally.

  • HTTP Status Code: 200

Response Elements

The following element is returned in a structure called the DescribeLoadBalancersResult.

• LoadBalancerDescriptions

  List of detailed information of a load balancer.

  • Type: LoadBalancerDescription list
• NextMarker

  Reserved parameter

  • Type: String

Errors

Refer to "Common Errors" for details on error information common to all operations.

• AccessPointNotFound

  The specified load balancer could not be found.

  • HTTP Status Code: 400

Examples

Sample Request

The example below retrieves information about the attributes of the load balancer named MyLB01.

       https://loadbalancing.(regionName).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"
         }
        }
       }