NAV Navigation
OSC CLI Shell

LBU API 2012-06-01

The Load Balancer Unit (LBU) API enables you to manage load balancers in the OUTSCALE Cloud.
It is compliant with the Elastic Load Balancing (ELB) API of Amazon Web Services (AWS). See the AWS Compatibility Matrix.

Authentication: About Signatures of API Requests
Throttling: If you exceed the number of identical requests allowed for a configured time period, a Throttling error message is returned.

Base URLs:

Terms of service Email: Support License: BSD 3 Clause

Authentication

Load Balancers

ConfigureHealthCheck

GET /ConfigureHealthCheck

Configures the health checks settings of a specified load balancer.
This action enables you to configure the settings of the availability tests that are regularly sent by a specified load balancer to its back-end instances.

Code samples

osc-cli lbu ConfigureHealthCheck --profile "default" \
  --HealthCheck '{ \
      "HealthyThreshold": 0, \
      "Interval": 0, \
      "Target": "string", \
      "Timeout": 0, \
      "UnhealthyThreshold": 0 \
    }' \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=ConfigureHealthCheck' \
  --data-urlencode 'HealthCheck.HealthyThreshold=0' \
  --data-urlencode 'HealthCheck.Interval=0' \
  --data-urlencode 'HealthCheck.Target=string' \
  --data-urlencode 'HealthCheck.Timeout=0' \
  --data-urlencode 'HealthCheck.UnhealthyThreshold=0' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
HealthCheck HealthCheck true Information about the health check configuration.
» HealthyThreshold integer false The number of consecutive successful pings before considering the instance as healthy (between 2 and 10 both included).
» Interval integer false The number of seconds between two pings (between 5 and 600 both included).
» Target string false The URL of the checked instance following the <protocol>:<port>/<path> format, with the following elements:- Protocol: TCP, SSL, HTTP or HTTPS.
- Port: Between 1 and 65535, both included.
- Path: If you use the HTTP or HTTPS protocols, the ping path.
» Timeout integer false The maximum waiting time for a response before considering the instance as unhealthy, in seconds (between 2 and 60 both included).
» UnhealthyThreshold integer false The number of consecutive failed pings before considering the instance as unhealthy (between 2 and 10 both included).
LoadBalancerName string true The name of the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ConfigureHealthCheckResponse

Example responses

200 Response

{
  "HealthCheck": {
    "HealthyThreshold": 0,
    "Interval": 0,
    "Target": "string",
    "Timeout": 0,
    "UnhealthyThreshold": 0
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateAppCookieStickinessPolicy

GET /CreateAppCookieStickinessPolicy

Creates a stickiness policy with sticky session lifetimes following the one of an application-generated cookie.
The created policy can be used only with HTTP listeners.
Unlike policies created using the CreateLBCookieStickinessPolicy method, the lifetime of the special Load Balancer Unit cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

Code samples

osc-cli lbu CreateAppCookieStickinessPolicy --profile "default" \
  --CookieName "string" \
  --LoadBalancerName "string" \
  --PolicyName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=CreateAppCookieStickinessPolicy' \
  --data-urlencode 'CookieName=string' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'PolicyName=string'

Parameters

Parameter Type Required Description
CookieName string true The name of the application cookie used for stickiness.
LoadBalancerName string true The name of the load balancer.
PolicyName string true The unique name of the policy (alphanumeric characters and dashes (-)).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateAppCookieStickinessPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateLBCookieStickinessPolicy

GET /CreateLBCookieStickinessPolicy

Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime or by a specified expiration period.
The created policy can be used with HTTP or HTTPS listeners only.
If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified back-end server instance. If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

Code samples

osc-cli lbu CreateLBCookieStickinessPolicy --profile "default" \
  --CookieExpirationPeriod 0 \
  --LoadBalancerName "string" \
  --PolicyName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=CreateLBCookieStickinessPolicy' \
  --data-urlencode 'CookieExpirationPeriod=0' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'PolicyName=string'

Parameters

Parameter Type Required Description
CookieExpirationPeriod integer false The lifetime of the cookie, in seconds. If not specified, the default value of this parameter is 1, which means that the sticky session lasts for the duration of the browser session.
LoadBalancerName string true The name of the load balancer.
PolicyName string true The name of the policy. This name must be unique and consist of alphanumeric characters and dashes (-).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateLBCookieStickinessPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateLoadBalancer

GET /CreateLoadBalancer

Creates a load balancer.
The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered instances.
By default, this action creates an Internet-facing load balancer, resolving to External IPs (EIPs). To create an internal load balancer in a Virtual Private Cloud (VPC), resolving to private IPs, use the Scheme parameter.
You must specify either the AvailabilityZones.member.N or the Subnets.member.N parameters.

Code samples

osc-cli lbu CreateLoadBalancer --profile "default" \
  --AvailabilityZones.member.1 "string" \
  --Listeners.member.1 '{ \
      "InstancePort": 0, \
      "InstanceProtocol": "string", \
      "LoadBalancerPort": 0, \
      "Protocol": "string", \
      "SSLCertificateId": "string" \
    }' \
  --LoadBalancerName "string" \
  --Scheme "string" \
  --SecurityGroups.member.1 "string" \
  --Subnets.member.1 "string" \
  --Tags.member.1 '{ \
      "Key": "string", \
      "Value": "string" \
    }'

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=CreateLoadBalancer' \
  --data-urlencode 'AvailabilityZones.member.1=string' \
  --data-urlencode 'Listeners.member.1.InstancePort=0' \
  --data-urlencode 'Listeners.member.1.InstanceProtocol=string' \
  --data-urlencode 'Listeners.member.1.LoadBalancerPort=0' \
  --data-urlencode 'Listeners.member.1.Protocol=string' \
  --data-urlencode 'Listeners.member.1.SSLCertificateId=string' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'Scheme=string' \
  --data-urlencode 'SecurityGroups.member.1=string' \
  --data-urlencode 'Subnets.member.1=string' \
  --data-urlencode 'Tags.member.1.Key=string' \
  --data-urlencode 'Tags.member.1.Value=string'

Parameters

Parameter Type Required Description
AvailabilityZones.member.N string false (public Cloud only) The Availability Zone (AZ) in which you want to create the load balancer. Regardless of this AZ, the load balancer can distribute traffic to all AZs. This parameter is required in the public Cloud.
Listeners.member.N Listeners.member.N true One or more listeners.
» InstancePort integer true The port on which the instance is listening (between 1 and 65535 both included).
» InstanceProtocol string true The protocol for routing traffic to back-end instances (HTTP | HTTPS | TCP | SSL).
» LoadBalancerPort integer true The port on which the load balancer is listening (between 1 and 65535 both included).
» Protocol string true The routing protocol (HTTP | HTTPS | TCP | SSL).
» SSLCertificateId string false The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see Resource Identifiers > OUTSCALE Resource Names (ORNs).
LoadBalancerName string true The unique name of the load balancer (32 alphanumeric or hyphen characters maximum, but cannot start or end with a hyphen).
Scheme string false The type of load balancer. Use this parameter only for load balancers in a VPC. To create an internal load balancer, set this parameter to internal.
SecurityGroups.member.N string false (VPC only) One or more IDs of security groups you want to assign to the load balancer. If not specified, the default security group of the VPC is assigned to the load balancer.
Subnets.member.N string false (VPC only) The ID of the subnet in which you want to create the load balancer. Regardless of this subnet, the load balancer can distribute traffic to all subnets. This parameter is required in a VPC.
Tags.member.N Tags.member.N false One or more tags assigned to the load balancer.
» Key string false The key of the tag, with a minimum of 1 character.
» Value string false The value of the tag, with a minimum of 0 character.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateLoadBalancerResponse

Example responses

200 Response

{
  "DNSName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateLoadBalancerListeners

GET /CreateLoadBalancerListeners

Creates one or more listeners for a specified load balancer.

Code samples

osc-cli lbu CreateLoadBalancerListeners --profile "default" \
  --Listeners.member.1 '{ \
      "InstancePort": 0, \
      "InstanceProtocol": "string", \
      "LoadBalancerPort": 0, \
      "Protocol": "string", \
      "SSLCertificateId": "string" \
    }' \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=CreateLoadBalancerListeners' \
  --data-urlencode 'Listeners.member.1.InstancePort=0' \
  --data-urlencode 'Listeners.member.1.InstanceProtocol=string' \
  --data-urlencode 'Listeners.member.1.LoadBalancerPort=0' \
  --data-urlencode 'Listeners.member.1.Protocol=string' \
  --data-urlencode 'Listeners.member.1.SSLCertificateId=string' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
Listeners.member.N Listeners.member.N true One or more listeners.
» InstancePort integer true The port on which the instance is listening (between 1 and 65535 both included).
» InstanceProtocol string true The protocol for routing traffic to back-end instances (HTTP | HTTPS | TCP | SSL).
» LoadBalancerPort integer true The port on which the load balancer is listening (between 1 and 65535 both included).
» Protocol string true The routing protocol (HTTP | HTTPS | TCP | SSL).
» SSLCertificateId string false The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see Resource Identifiers > OUTSCALE Resource Names (ORNs).
LoadBalancerName string true The name of load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateLoadBalancerListenersResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateLoadBalancerPolicy

GET /CreateLoadBalancerPolicy

Creates a policy for the specified load balancer.

Code samples

osc-cli lbu CreateLoadBalancerPolicy --profile "default" \
  --LoadBalancerName "string" \
  --PolicyName "string" \
  --PolicyTypeName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=CreateLoadBalancerPolicy' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'PolicyName=string' \
  --data-urlencode 'PolicyTypeName=string'

Parameters

Parameter Type Required Description
LoadBalancerName string true The name of the load balancer.
PolicyName string true The name of the load balancer policy to create. This name must be unique within the policies of the specified load balancer.
PolicyTypeName string true The name of the base policy type (only ProxyProtocolPolicyType is supported).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateLoadBalancerPolicyResponse

Example responses

200 Response

{}

DeleteLoadBalancer

GET /DeleteLoadBalancer

Deletes a specified load balancer.

Code samples

osc-cli lbu DeleteLoadBalancer --profile "default" \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DeleteLoadBalancer' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
LoadBalancerName string true The name of the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteLoadBalancerResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteLoadBalancerListeners

GET /DeleteLoadBalancerListeners

Deletes listeners of a specified load balancer.

Code samples

osc-cli lbu DeleteLoadBalancerListeners --profile "default" \
  --LoadBalancerName "string" \
  --LoadBalancerPorts.member.1 0

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DeleteLoadBalancerListeners' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'LoadBalancerPorts.member.1=0'

Parameters

Parameter Type Required Description
LoadBalancerName string true The name of the load balancer.
LoadBalancerPorts.member.N integer true The port numbers of the listeners.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteLoadBalancerListenersResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteLoadBalancerPolicy

GET /DeleteLoadBalancerPolicy

Deletes a specified policy from a load balancer.
In order to be deleted, the policy must not be enabled for any listener.

Code samples

osc-cli lbu DeleteLoadBalancerPolicy --profile "default" \
  --LoadBalancerName "string" \
  --PolicyName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DeleteLoadBalancerPolicy' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'PolicyName=string'

Parameters

Parameter Type Required Description
LoadBalancerName string true The name of the load balancer.
PolicyName string true The name of the policy.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteLoadBalancerPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeregisterInstancesFromLoadBalancer

GET /DeregisterInstancesFromLoadBalancer

Deregisters a specified instance from a load balancer.

Code samples

osc-cli lbu DeregisterInstancesFromLoadBalancer --profile "default" \
  --Instances.member.1 '{ \
      "InstanceId": "string" \
    }' \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DeregisterInstancesFromLoadBalancer' \
  --data-urlencode 'Instances.member.1.InstanceId=string' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
Instances.member.N Instances.member.N true Information about one or more instances.
» InstanceId string true The ID of the instance.
LoadBalancerName string true The name of the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeregisterInstancesFromLoadBalancerResponse

Example responses

200 Response

{
  "Instances.member.N": {
    "InstanceId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeInstanceHealth

GET /DescribeInstanceHealth

Describes the state of one or more back-end instances registered with a specified load balancer.

Code samples

osc-cli lbu DescribeInstanceHealth --profile "default" \
  --Instances.member.1 '{ \
      "InstanceId": "string" \
    }' \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DescribeInstanceHealth' \
  --data-urlencode 'Instances.member.1.InstanceId=string' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
Instances.member.N Instances.member.N false Information about one or more instances.
» InstanceId string true The ID of the instance.
LoadBalancerName string true The name of the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeInstanceHealthResponse

Example responses

200 Response

{
  "InstanceStates.member.N": {
    "Description": "string",
    "InstanceId": "string",
    "ReasonCode": "string",
    "State": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeLoadBalancerAttributes

GET /DescribeLoadBalancerAttributes

Describes the attributes of the specified load balancer.

Code samples

osc-cli lbu DescribeLoadBalancerAttributes --profile "default" \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DescribeLoadBalancerAttributes' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
LoadBalancerName string true The name of the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeLoadBalancerAttributesResponse

Example responses

200 Response

{
  "LoadBalancerAttributes": {
    "AccessLog": {
      "EmitInterval": 0,
      "Enabled": true,
      "S3BucketName": "string",
      "S3BucketPrefix": "string"
    },
    "AdditionalAttributes.member.N": {
      "Key": "string",
      "Value": "string"
    },
    "ConnectionDraining": {
      "Enabled": true,
      "Timeout": 0
    },
    "ConnectionSettings": {
      "IdleTimeout": 0
    }
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeLoadBalancers

GET /DescribeLoadBalancers

Describes one or more load balancers.

Code samples

osc-cli lbu DescribeLoadBalancers --profile "default" \
  --LoadBalancerNames.member.1 "string" \
  --Marker "string" \
  --PageSize 0

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DescribeLoadBalancers' \
  --data-urlencode 'LoadBalancerNames.member.1=string' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'PageSize=0'

Parameters

Parameter Type Required Description
LoadBalancerNames.member.N string false The name of one or more load balancers.
Marker string false The marker to request the next results page.
PageSize integer false The maximum number of results that can be returned in a single page.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeLoadBalancersResponse

Example responses

200 Response

{
  "LoadBalancerDescriptions.member.N": {
    "AvailabilityZones.member.N": "string",
    "BackendServerDescriptions.member.N": {
      "InstancePort": 0,
      "PolicyNames.member.N": "string"
    },
    "CreatedTime": "string",
    "DNSName": "string",
    "HealthCheck": {
      "HealthyThreshold": 0,
      "Interval": 0,
      "Target": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Instances.member.N": {
      "InstanceId": "string"
    },
    "ListenerDescriptions.member.N": {
      "Listener": {
        "InstancePort": 0,
        "InstanceProtocol": "string",
        "LoadBalancerPort": 0,
        "Protocol": "string",
        "SSLCertificateId": "string"
      },
      "PolicyNames.member.N": "string"
    },
    "LoadBalancerName": "string",
    "Policies": {
      "AppCookieStickinessPolicies.member.N": {
        "CookieName": "string",
        "PolicyName": "string"
      },
      "LBCookieStickinessPolicies.member.N": {
        "CookieExpirationPeriod": 0,
        "PolicyName": "string"
      },
      "OtherPolicies.member.N": "string"
    },
    "Scheme": "string",
    "SecurityGroups.member.N": "string",
    "SourceSecurityGroup": {
      "GroupName": "string",
      "OwnerAlias": "string"
    },
    "Subnets.member.N": "string",
    "VPCId": "string"
  },
  "NextMarker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ModifyLoadBalancerAttributes

GET /ModifyLoadBalancerAttributes

Modifies the specified attributes of a load balancer.

Code samples

osc-cli lbu ModifyLoadBalancerAttributes --profile "default" \
  --LoadBalancerAttributes '{ \
      "AccessLog": { \
        "EmitInterval": 0, \
        "Enabled": True, \
        "S3BucketName": "string", \
        "S3BucketPrefix": "string" \
      }, \
      "AdditionalAttributes.member.N": { \
        "Key": "string", \
        "Value": "string" \
      }, \
      "ConnectionDraining": { \
        "Enabled": True, \
        "Timeout": 0 \
      }, \
      "ConnectionSettings": { \
        "IdleTimeout": 0 \
      } \
    }' \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=ModifyLoadBalancerAttributes' \
  --data-urlencode 'LoadBalancerAttributes.AccessLog.EmitInterval=0' \
  --data-urlencode 'LoadBalancerAttributes.AccessLog.Enabled=true' \
  --data-urlencode 'LoadBalancerAttributes.AccessLog.S3BucketName=string' \
  --data-urlencode 'LoadBalancerAttributes.AccessLog.S3BucketPrefix=string' \
  --data-urlencode 'LoadBalancerAttributes.AdditionalAttributes.member.N.Key=string' \
  --data-urlencode 'LoadBalancerAttributes.AdditionalAttributes.member.N.Value=string' \
  --data-urlencode 'LoadBalancerAttributes.ConnectionDraining.Enabled=true' \
  --data-urlencode 'LoadBalancerAttributes.ConnectionDraining.Timeout=0' \
  --data-urlencode 'LoadBalancerAttributes.ConnectionSettings.IdleTimeout=0' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
LoadBalancerAttributes LoadBalancerAttributes true The attributes of the load balancer.
» AccessLog AccessLog false Information about the publication of the access logs.
»» EmitInterval integer false The time interval for the publication of access logs in the OUTSCALE Object Storage (OOS) bucket, in minutes. This value can be either 5 or 60 (by default, 60).
»» Enabled boolean false If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the S3BucketName parameter is required.
»» S3BucketName string false The name of the OOS bucket for the access logs.
»» S3BucketPrefix string false The path to the folder of the access logs in your OOS bucket (by default, the root level of your bucket).
» AdditionalAttributes.member.N AdditionalAttributes.member.N false Information about additional load balancer attributes, for example secure cookies.
»» Key string false The name of the attribute.
You can configure secure cookies on your load balancer with SecuredCookies (secured_cookies in the response).
»» Value string false The value of the attribute.
If the Key is SecuredCookies, set the Value to true to enable secure cookies and false to disable them.
» ConnectionDraining ConnectionDraining false Information about the draining of the connections to unhealthy or deregistered instances.
»» Enabled boolean false If set to true, connection draining is enabled for your load balancer. In this case, existing requests are completed before the connections are closed. By default, set to false.
»» Timeout integer false The maximum time the load balancer keeps the existing connections open before deregistering instances, in seconds (by default, 20).
» ConnectionSettings ConnectionSettings false Information about idle connections.
»» IdleTimeout integer false The time that the connection is allowed to be idle, meaning no data is sent over, before it is closed by the load balancer, in seconds.
By default, set to 30 for the front-end connection and 60 for the back-end connection of your load balancer.
If you set a new duration, the same value is applied to both the front-end and back-end connections.
» LoadBalancerName string true The name of the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ModifyLoadBalancerAttributesResponse

Example responses

200 Response

{
  "LoadBalancerAttributes": {
    "AccessLog": {
      "EmitInterval": 0,
      "Enabled": true,
      "S3BucketName": "string",
      "S3BucketPrefix": "string"
    },
    "AdditionalAttributes.member.N": {
      "Key": "string",
      "Value": "string"
    },
    "ConnectionDraining": {
      "Enabled": true,
      "Timeout": 0
    },
    "ConnectionSettings": {
      "IdleTimeout": 0
    }
  },
  "LoadBalancerName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

RegisterInstancesWithLoadBalancer

GET /RegisterInstancesWithLoadBalancer

Registers one or more instances with a specified load balancer.
The instances can be in different subnets and different availability zones than the load balancer, as long as the instances and load balancers are all in the public Cloud or all in the same VPC. It may take a little time for an instance to be registered with the load balancer. Once the instance is registered with a load balancer, it receives traffic and requests from this load balancer and is called a back-end instance.

Code samples

osc-cli lbu RegisterInstancesWithLoadBalancer --profile "default" \
  --Instances.member.1 '{ \
      "InstanceId": "string" \
    }' \
  --LoadBalancerName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=RegisterInstancesWithLoadBalancer' \
  --data-urlencode 'Instances.member.1.InstanceId=string' \
  --data-urlencode 'LoadBalancerName=string'

Parameters

Parameter Type Required Description
Instances.member.N Instances.member.N true Information about one or more instances.
» InstanceId string true The ID of the instance.
LoadBalancerName string true The name of the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RegisterInstancesWithLoadBalancerResponse

Example responses

200 Response

{
  "Instances.member.N": {
    "InstanceId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

SetLoadBalancerListenerSSLCertificate

GET /SetLoadBalancerListenerSSLCertificate

Sets a new SSL certificate to an SSL or HTTPS listener of a load balancer.
This certificate replaces any certificate used on the same load balancer and port. To do so, you first need to upload a certificate using the UploadServerCertificate method in the Elastic Identity Management (EIM) API.

Code samples

osc-cli lbu SetLoadBalancerListenerSSLCertificate --profile "default" \
  --LoadBalancerName "string" \
  --LoadBalancerPort 0 \
  --SSLCertificateId "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=SetLoadBalancerListenerSSLCertificate' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'LoadBalancerPort=0' \
  --data-urlencode 'SSLCertificateId=string'

Parameters

Parameter Type Required Description
LoadBalancerName string true The name of the load balancer.
LoadBalancerPort integer true The port using the SSL certificate.
SSLCertificateId string true The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see Resource Identifiers > OUTSCALE Resource Names (ORNs).

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). SetLoadBalancerListenerSSLCertificateResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

SetLoadBalancerPoliciesForBackendServer

GET /SetLoadBalancerPoliciesForBackendServer

Replaces the set of policies enabled for the specified port on which the instance is listening with a new set of policies.
You can use the DescribeLoadBalancers method to list the policies associated with the instance. For more information, see DescribeLoadBalancers.

Code samples

osc-cli lbu SetLoadBalancerPoliciesForBackendServer --profile "default" \
  --InstancePort 0 \
  --LoadBalancerName "string" \
  --PolicyNames.member.1 "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=SetLoadBalancerPoliciesForBackendServer' \
  --data-urlencode 'InstancePort=0' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'PolicyNames.member.1=string'

Parameters

Parameter Type Required Description
InstancePort integer true The port on which the instance is listening.
LoadBalancerName string true The name of the load balancer.
PolicyNames.member.N string true The names of all the policies you want to enable for your load balancer. You need to list the already enabled policies that you want to keep along with the new ones you are enabling. If the list is empty, then all current policies are removed from the instance.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). SetLoadBalancerPoliciesForBackendServerResponse

Example responses

200 Response

{}

SetLoadBalancerPoliciesOfListener

GET /SetLoadBalancerPoliciesOfListener

Replaces the currently enabled policy for a load balancer with another one.
If the PolicyNames.member.N parameter is empty, the currently enabled policy is disabled.

Code samples

osc-cli lbu SetLoadBalancerPoliciesOfListener --profile "default" \
  --LoadBalancerName "string" \
  --LoadBalancerPort 0 \
  --PolicyNames.member.1 "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=SetLoadBalancerPoliciesOfListener' \
  --data-urlencode 'LoadBalancerName=string' \
  --data-urlencode 'LoadBalancerPort=0' \
  --data-urlencode 'PolicyNames.member.1=string'

Parameters

Parameter Type Required Description
LoadBalancerName string true The name of the load balancer.
LoadBalancerPort integer true The external port of the load balancer.
PolicyNames.member.N string true The name of the policy you want to enable for the listener.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). SetLoadBalancerPoliciesOfListenerResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Tags

AddTags

GET /AddTags

Adds one or more tags to the specified load balancers.
If a tag with the same key already exists for the load balancer, the tag value is replaced.

Code samples

osc-cli lbu AddTags --profile "default" \
  --LoadBalancerNames.member.1 "string" \
  --Tags.member.1 '{ \
      "Key": "string", \
      "Value": "string" \
    }'

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=AddTags' \
  --data-urlencode 'LoadBalancerNames.member.1=string' \
  --data-urlencode 'Tags.member.1.Key=string' \
  --data-urlencode 'Tags.member.1.Value=string'

Parameters

Parameter Type Required Description
LoadBalancerNames.member.N string true The name of a load balancer.
Tags.member.N Tags.member.N true One or more tags assigned to the load balancer.
» Key string false The key of the tag, with a minimum of 1 character.
» Value string false The value of the tag, with a minimum of 0 character.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AddTagsResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeTags

GET /DescribeTags

Describes the tags associated with one or more specified load balancers.

Code samples

osc-cli lbu DescribeTags --profile "default" \
  --LoadBalancerNames.member.1 "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=DescribeTags' \
  --data-urlencode 'LoadBalancerNames.member.1=string'

Parameters

Parameter Type Required Description
LoadBalancerNames.member.N string true The name of one or more load balancers.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeTagsResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "TagDescriptions.member.N": {
    "LoadBalancerName": "string",
    "Tags.member.N": {
      "Key": "string",
      "Value": "string"
    }
  }
}

RemoveTags

GET /RemoveTags

Deletes one or more tags from the specified load balancers.

Code samples

osc-cli lbu RemoveTags --profile "default" \
  --LoadBalancerNames.member.1 "string" \
  --Tags.member.N.Key "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://lbu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2012-06-01' \
  --data-urlencode 'Action=RemoveTags' \
  --data-urlencode 'LoadBalancerNames.member.1=string' \
  --data-urlencode 'Tags.member.N.Key=string'

Parameters

Parameter Type Required Description
LoadBalancerNames.member.N string true The name of a load balancer.
Tags.member.N.Key string true The key of a tag you want to delete from the load balancer.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RemoveTagsResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Schemas

AccessLog

Information about the publication of the access logs.

Properties

Name Type Required Restrictions Description
EmitInterval integer false none The time interval for the publication of access logs in the OUTSCALE Object Storage (OOS) bucket, in minutes. This value can be either 5 or 60 (by default, 60).
Enabled boolean false none If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the S3BucketName parameter is required.
S3BucketName string false none The name of the OOS bucket for the access logs.
S3BucketPrefix string false none The path to the folder of the access logs in your OOS bucket (by default, the root level of your bucket).

Schema

{
  "EmitInterval": 0,
  "Enabled": true,
  "S3BucketName": "string",
  "S3BucketPrefix": "string"
}

AddTagsResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

AdditionalAttributes.member.N

Information about additional load balancer attributes, for example secure cookies.

Properties

Name Type Required Restrictions Description
Key string false none The name of the attribute.
You can configure secure cookies on your load balancer with SecuredCookies (secured_cookies in the response).
Value string false none The value of the attribute.
If the Key is SecuredCookies, set the Value to true to enable secure cookies and false to disable them.

Schema

{
  "Key": "string",
  "Value": "string"
}

AppCookieStickinessPolicies.member.N

The stickiness policies created using CreateAppCookieStickinessPolicy.

Properties

Name Type Required Restrictions Description
CookieName string false none The name of the application cookie used for stickiness.
PolicyName string false none The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.

Schema

{
  "CookieName": "string",
  "PolicyName": "string"
}

BackendServerDescriptions.member.N

Information about the configuration of your instances.

Properties

Name Type Required Restrictions Description
InstancePort integer false none The port on which the instance is listening (between 1 and 65535, both included).
PolicyNames.member.N string false none The names of the policies enabled for the instance.

Schema

{
  "InstancePort": 0,
  "PolicyNames.member.N": "string"
}

ConfigureHealthCheckResponse

Properties

Name Type Required Restrictions Description
HealthCheck HealthCheck false none Information about the health check configuration.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "HealthCheck": {
    "HealthyThreshold": 0,
    "Interval": 0,
    "Target": "string",
    "Timeout": 0,
    "UnhealthyThreshold": 0
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ConnectionDraining

Information about the draining of the connections to unhealthy or deregistered instances.

Properties

Name Type Required Restrictions Description
Enabled boolean false none If set to true, connection draining is enabled for your load balancer. In this case, existing requests are completed before the connections are closed. By default, set to false.
Timeout integer false none The maximum time the load balancer keeps the existing connections open before deregistering instances, in seconds (by default, 20).

Schema

{
  "Enabled": true,
  "Timeout": 0
}

ConnectionSettings

Information about idle connections.

Properties

Name Type Required Restrictions Description
IdleTimeout integer false none The time that the connection is allowed to be idle, meaning no data is sent over, before it is closed by the load balancer, in seconds.
By default, set to 30 for the front-end connection and 60 for the back-end connection of your load balancer.
If you set a new duration, the same value is applied to both the front-end and back-end connections.

Schema

{
  "IdleTimeout": 0
}

CreateAppCookieStickinessPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateLBCookieStickinessPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateLoadBalancerListenersResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateLoadBalancerPolicyResponse

Properties

None

Schema

{}

CreateLoadBalancerResponse

Properties

Name Type Required Restrictions Description
DNSName string false none The DNS name of the load balancer.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "DNSName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteLoadBalancerListenersResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteLoadBalancerPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteLoadBalancerResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeregisterInstancesFromLoadBalancerResponse

Properties

Name Type Required Restrictions Description
Instances.member.N Instances.member.N false none Information about one or more instances.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Instances.member.N": {
    "InstanceId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeInstanceHealthResponse

Properties

Name Type Required Restrictions Description
InstanceStates.member.N InstanceStates.member.N false none Information about the health of one or more back-end instances.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "InstanceStates.member.N": {
    "Description": "string",
    "InstanceId": "string",
    "ReasonCode": "string",
    "State": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeLoadBalancerAttributesResponse

Properties

Name Type Required Restrictions Description
LoadBalancerAttributes LoadBalancerAttributes false none The attributes of the load balancer.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "LoadBalancerAttributes": {
    "AccessLog": {
      "EmitInterval": 0,
      "Enabled": true,
      "S3BucketName": "string",
      "S3BucketPrefix": "string"
    },
    "AdditionalAttributes.member.N": {
      "Key": "string",
      "Value": "string"
    },
    "ConnectionDraining": {
      "Enabled": true,
      "Timeout": 0
    },
    "ConnectionSettings": {
      "IdleTimeout": 0
    }
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeLoadBalancersResponse

Properties

Name Type Required Restrictions Description
LoadBalancerDescriptions.member.N LoadBalancerDescriptions.member.N false none Information about one or more load balancers.
NextMarker string false none The marker to request the next results page (empty if there is no more results to return).
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "LoadBalancerDescriptions.member.N": {
    "AvailabilityZones.member.N": "string",
    "BackendServerDescriptions.member.N": {
      "InstancePort": 0,
      "PolicyNames.member.N": "string"
    },
    "CreatedTime": "string",
    "DNSName": "string",
    "HealthCheck": {
      "HealthyThreshold": 0,
      "Interval": 0,
      "Target": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Instances.member.N": {
      "InstanceId": "string"
    },
    "ListenerDescriptions.member.N": {
      "Listener": {
        "InstancePort": 0,
        "InstanceProtocol": "string",
        "LoadBalancerPort": 0,
        "Protocol": "string",
        "SSLCertificateId": "string"
      },
      "PolicyNames.member.N": "string"
    },
    "LoadBalancerName": "string",
    "Policies": {
      "AppCookieStickinessPolicies.member.N": {
        "CookieName": "string",
        "PolicyName": "string"
      },
      "LBCookieStickinessPolicies.member.N": {
        "CookieExpirationPeriod": 0,
        "PolicyName": "string"
      },
      "OtherPolicies.member.N": "string"
    },
    "Scheme": "string",
    "SecurityGroups.member.N": "string",
    "SourceSecurityGroup": {
      "GroupName": "string",
      "OwnerAlias": "string"
    },
    "Subnets.member.N": "string",
    "VPCId": "string"
  },
  "NextMarker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeTagsResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.
TagDescriptions.member.N TagDescriptions.member.N false none Information about the tags associated with the specified load balancers.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "TagDescriptions.member.N": {
    "LoadBalancerName": "string",
    "Tags.member.N": {
      "Key": "string",
      "Value": "string"
    }
  }
}

HealthCheck

Information about the health check configuration.

Properties

Name Type Required Restrictions Description
HealthyThreshold integer false none The number of consecutive successful pings before considering the instance as healthy (between 2 and 10 both included).
Interval integer false none The number of seconds between two pings (between 5 and 600 both included).
Target string false none The URL of the checked instance following the <protocol>:<port>/<path> format, with the following elements: - Protocol: TCP, SSL, HTTP or HTTPS.
- Port: Between 1 and 65535, both included.
- Path: If you use the HTTP or HTTPS protocols, the ping path.
Timeout integer false none The maximum waiting time for a response before considering the instance as unhealthy, in seconds (between 2 and 60 both included).
UnhealthyThreshold integer false none The number of consecutive failed pings before considering the instance as unhealthy (between 2 and 10 both included).

Schema

{
  "HealthyThreshold": 0,
  "Interval": 0,
  "Target": "string",
  "Timeout": 0,
  "UnhealthyThreshold": 0
}

InstanceStates.member.N

Information about the health of one or more back-end instances.

Properties

Name Type Required Restrictions Description
Description string false none A description of the instance state.
InstanceId string false none The ID of the instance.
ReasonCode string false none Information about the cause of OutOfService instances.
Specifically, whether the cause is Elastic Load Balancing or the instance (ELB | Instance | N/A).
State string false none The current state of the instance (InService | OutOfService | Unknown).

Schema

{
  "Description": "string",
  "InstanceId": "string",
  "ReasonCode": "string",
  "State": "string"
}

Instances.member.N

Information about one or more instances.

Properties

Name Type Required Restrictions Description
InstanceId string true none The ID of the instance.

Schema

{
  "InstanceId": "string"
}

LBCookieStickinessPolicies.member.N

The stickiness policies created using CreateLBCookieStickinessPolicy.

Properties

Name Type Required Restrictions Description
CookieExpirationPeriod integer false none The time period, in seconds, after which the cookie should be considered stale.
If 1, the stickiness session lasts for the duration of the browser session.
PolicyName string false none The name of the policy. This name must be unique within the set of policies for this load balancer.

Schema

{
  "CookieExpirationPeriod": 0,
  "PolicyName": "string"
}

Listener

The listener.

Properties

Name Type Required Restrictions Description
InstancePort integer false none The port on which the instance is listening (between 1 and 65535 both included).
InstanceProtocol string false none The protocol for routing traffic to back-end instances (HTTP | HTTPS | TCP | SSL).
LoadBalancerPort integer false none The port on which the load balancer is listening (between 1 and 65535 both included).
Protocol string false none The routing protocol (HTTP | HTTPS | TCP | SSL).
SSLCertificateId string false none The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see Resource Identifiers > OUTSCALE Resource Names (ORNs).

Schema

{
  "InstancePort": 0,
  "InstanceProtocol": "string",
  "LoadBalancerPort": 0,
  "Protocol": "string",
  "SSLCertificateId": "string"
}

ListenerDescriptions.member.N

The listeners for the load balancer.

Properties

Name Type Required Restrictions Description
Listener Listener false none The listener.
PolicyNames.member.N string false none The policies. If there are no policies enabled, the list is empty.

Schema

{
  "Listener": {
    "InstancePort": 0,
    "InstanceProtocol": "string",
    "LoadBalancerPort": 0,
    "Protocol": "string",
    "SSLCertificateId": "string"
  },
  "PolicyNames.member.N": "string"
}

Listeners.member.N

One or more listeners.

Properties

Name Type Required Restrictions Description
InstancePort integer true none The port on which the instance is listening (between 1 and 65535 both included).
InstanceProtocol string true none The protocol for routing traffic to back-end instances (HTTP | HTTPS | TCP | SSL).
LoadBalancerPort integer true none The port on which the load balancer is listening (between 1 and 65535 both included).
Protocol string true none The routing protocol (HTTP | HTTPS | TCP | SSL).
SSLCertificateId string false none The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see Resource Identifiers > OUTSCALE Resource Names (ORNs).

Schema

{
  "InstancePort": 0,
  "InstanceProtocol": "string",
  "LoadBalancerPort": 0,
  "Protocol": "string",
  "SSLCertificateId": "string"
}

LoadBalancerAttributes

The attributes of the load balancer.

Properties

Name Type Required Restrictions Description
AccessLog AccessLog false none Information about the publication of the access logs.
AdditionalAttributes.member.N AdditionalAttributes.member.N false none Information about additional load balancer attributes, for example secure cookies.
ConnectionDraining ConnectionDraining false none Information about the draining of the connections to unhealthy or deregistered instances.
ConnectionSettings ConnectionSettings false none Information about idle connections.

Schema

{
  "AccessLog": {
    "EmitInterval": 0,
    "Enabled": true,
    "S3BucketName": "string",
    "S3BucketPrefix": "string"
  },
  "AdditionalAttributes.member.N": {
    "Key": "string",
    "Value": "string"
  },
  "ConnectionDraining": {
    "Enabled": true,
    "Timeout": 0
  },
  "ConnectionSettings": {
    "IdleTimeout": 0
  }
}

LoadBalancerDescriptions.member.N

Information about one or more load balancers.

Properties

Name Type Required Restrictions Description
AvailabilityZones.member.N string false none The ID of the AZ in which the load balancer was created.
BackendServerDescriptions.member.N BackendServerDescriptions.member.N false none Information about the configuration of your instances.
CreatedTime string false none The date and time the load balancer was created.
DNSName string false none The DNS name of the load balancer.
HealthCheck HealthCheck false none Information about the health check configuration.
Instances.member.N Instances.member.N false none Information about one or more instances.
ListenerDescriptions.member.N ListenerDescriptions.member.N false none The listeners for the load balancer.
LoadBalancerName string false none The name of the load balancer.
Policies Policies false none The policies defined for the load balancer.
Scheme string false none The type of load balancer. Valid only for load balancers in a VPC.
If Scheme is internet-facing, the load balancer has a public DNS name that resolves to an External IP (EIP).
If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP.
SecurityGroups.member.N string false none The security groups for the load balancer. Valid only for load balancers in a VPC.
SourceSecurityGroup SourceSecurityGroup false none The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.
Subnets.member.N string false none The ID of the subnet in which the load balancer was created.
VPCId string false none The ID of the VPC for the load balancer.

Schema

{
  "AvailabilityZones.member.N": "string",
  "BackendServerDescriptions.member.N": {
    "InstancePort": 0,
    "PolicyNames.member.N": "string"
  },
  "CreatedTime": "string",
  "DNSName": "string",
  "HealthCheck": {
    "HealthyThreshold": 0,
    "Interval": 0,
    "Target": "string",
    "Timeout": 0,
    "UnhealthyThreshold": 0
  },
  "Instances.member.N": {
    "InstanceId": "string"
  },
  "ListenerDescriptions.member.N": {
    "Listener": {
      "InstancePort": 0,
      "InstanceProtocol": "string",
      "LoadBalancerPort": 0,
      "Protocol": "string",
      "SSLCertificateId": "string"
    },
    "PolicyNames.member.N": "string"
  },
  "LoadBalancerName": "string",
  "Policies": {
    "AppCookieStickinessPolicies.member.N": {
      "CookieName": "string",
      "PolicyName": "string"
    },
    "LBCookieStickinessPolicies.member.N": {
      "CookieExpirationPeriod": 0,
      "PolicyName": "string"
    },
    "OtherPolicies.member.N": "string"
  },
  "Scheme": "string",
  "SecurityGroups.member.N": "string",
  "SourceSecurityGroup": {
    "GroupName": "string",
    "OwnerAlias": "string"
  },
  "Subnets.member.N": "string",
  "VPCId": "string"
}

ModifyLoadBalancerAttributesResponse

Properties

Name Type Required Restrictions Description
LoadBalancerAttributes LoadBalancerAttributes false none The attributes of the load balancer.
LoadBalancerName string false none The name of the load balancer.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "LoadBalancerAttributes": {
    "AccessLog": {
      "EmitInterval": 0,
      "Enabled": true,
      "S3BucketName": "string",
      "S3BucketPrefix": "string"
    },
    "AdditionalAttributes.member.N": {
      "Key": "string",
      "Value": "string"
    },
    "ConnectionDraining": {
      "Enabled": true,
      "Timeout": 0
    },
    "ConnectionSettings": {
      "IdleTimeout": 0
    }
  },
  "LoadBalancerName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Policies

The policies defined for the load balancer.

Properties

Name Type Required Restrictions Description
AppCookieStickinessPolicies.member.N AppCookieStickinessPolicies.member.N false none The stickiness policies created using CreateAppCookieStickinessPolicy.
LBCookieStickinessPolicies.member.N LBCookieStickinessPolicies.member.N false none The stickiness policies created using CreateLBCookieStickinessPolicy.
OtherPolicies.member.N string false none The policies other than the stickiness policies.

Schema

{
  "AppCookieStickinessPolicies.member.N": {
    "CookieName": "string",
    "PolicyName": "string"
  },
  "LBCookieStickinessPolicies.member.N": {
    "CookieExpirationPeriod": 0,
    "PolicyName": "string"
  },
  "OtherPolicies.member.N": "string"
}

RegisterInstancesWithLoadBalancerResponse

Properties

Name Type Required Restrictions Description
Instances.member.N Instances.member.N false none Information about one or more instances.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Instances.member.N": {
    "InstanceId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

RemoveTagsResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ResponseMetadata

Information about the response.

Properties

Name Type Required Restrictions Description
RequestId string false none The ID of the request.

Schema

{
  "RequestId": "string"
}

SetLoadBalancerListenerSSLCertificateResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

SetLoadBalancerPoliciesForBackendServerResponse

Properties

None

Schema

{}

SetLoadBalancerPoliciesOfListenerResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

SourceSecurityGroup

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

Properties

Name Type Required Restrictions Description
GroupName string false none The name of the security group.
OwnerAlias string false none The owner of the security group.

Schema

{
  "GroupName": "string",
  "OwnerAlias": "string"
}

TagDescriptions.member.N

Information about the tags associated with the specified load balancers.

Properties

Name Type Required Restrictions Description
LoadBalancerName string false none The name of the load balancer.
Tags.member.N Tags.member.N false none One or more tags assigned to the load balancer.

Schema

{
  "LoadBalancerName": "string",
  "Tags.member.N": {
    "Key": "string",
    "Value": "string"
  }
}

Tags.member.N

One or more tags assigned to the load balancer.

Properties

Name Type Required Restrictions Description
Key string false none The key of the tag, with a minimum of 1 character.
Value string false none The value of the tag, with a minimum of 0 character.

Schema

{
  "Key": "string",
  "Value": "string"
}

Copyright © 2023 Outscale SAS. All rights reserved.