NAV Navigation

LBU API 2012-06-01

The Load Balancer Unit (LBU) API enables you to manage load balancers in the 3DS 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.

Parameters

Parameter In Type Required Description
HealthCheck body HealthCheck true Information about the health check configuration.
» HealthyThreshold body integer false The number of consecutive successful pings before considering the instance as healthy (between 2 and 10 both included).
» Interval body integer false The number of seconds between two pings (between 5 and 600 both included).
» Target body string false The URL of the checked instance following the <protocol>:<port>/<path> format, with the following elements:
» Timeout body integer false The maximum waiting time for a response before considering the instance as unhealthy, in seconds (between 2 and 60 both included).
» UnhealthyThreshold body integer false The number of consecutive failed pings before considering the instance as unhealthy (between 2 and 10 both included).
LoadBalancerName body string true The name of the load balancer.

Detailed descriptions

» Target: The URL of the checked instance following the <protocol>:<port>/<path> format, with the following elements:

Body parameter

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

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.

Parameters

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

Body parameter

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

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.

Parameters

Parameter In Type Required Description
CookieExpirationPeriod body 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 body string true The name of the load balancer.
PolicyName body string true The name of the policy. This name must be unique and consist of alphanumeric characters and dashes (-).

Body parameter

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

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 public IP addresses. To create an internal load balancer in a Virtual Private Cloud (VPC), resolving to private IP addresses, use the Scheme parameter.

Parameters

Parameter In Type Required Description
AvailabilityZones.member body [string] true The name of the Availability Zone (currently, only one AZ is supported). This parameter is not required if you create a load balancer in a VPC. To create an internal load balancer, use the Scheme parameter.
Listeners.member body [Listeners.member] true One or more listeners.
» InstancePort body integer false The port on which the instance is listening (between 1 and 65535 both included).
» InstanceProtocol body string false The protocol for routing traffic to back-end instances (HTTP | HTTPS | TCP | SSL | UDP).
» LoadBalancerPort body integer false The port on which the load balancer is listening (between 1 and 65535 both included).
» Protocol body string false The routing protocol (HTTP | HTTPS | TCP | SSL | UDP).
» SSLCertificateId body string false The ID of the server certificate.
LoadBalancerName body string true The unique name of the load balancer (32 alphanumeric or hyphen characters maximum, but cannot start or end with a hyphen).
Scheme body 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 body [string] false One or more security groups you want to assign to the load balancer.
Subnets.member body [string] false One or more subnet IDs in your VPC to attach to the load balancer.
Tags.member body [Tags.member] false One or more tags assigned to the load balancer.
» Key body string false The key of the tag, with a minimum of 1 character.
» Value body string false The value of the tag, with a minimum of 0 character.

Detailed descriptions

SecurityGroups.member: One or more security groups you want to assign to the load balancer. In a VPC, the default security group is assigned if this parameter is not specified.

Body parameter

{
  "AvailabilityZones.member": [
    "string"
  ],
  "Listeners.member": [
    {
      "InstancePort": 0,
      "InstanceProtocol": "string",
      "LoadBalancerPort": 0,
      "Protocol": "string",
      "SSLCertificateId": "string"
    }
  ],
  "LoadBalancerName": "string",
  "Scheme": "string",
  "SecurityGroups.member": [
    "string"
  ],
  "Subnets.member": [
    "string"
  ],
  "Tags.member": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

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.

Parameters

Parameter In Type Required Description
Listeners.member body [Listeners.member] true One or more listeners.
» InstancePort body integer false The port on which the instance is listening (between 1 and 65535 both included).
» InstanceProtocol body string false The protocol for routing traffic to back-end instances (HTTP | HTTPS | TCP | SSL | UDP).
» LoadBalancerPort body integer false The port on which the load balancer is listening (between 1 and 65535 both included).
» Protocol body string false The routing protocol (HTTP | HTTPS | TCP | SSL | UDP).
» SSLCertificateId body string false The ID of the server certificate.
LoadBalancerName body string true The name of load balancer.

Body parameter

{
  "Listeners.member": [
    {
      "InstancePort": 0,
      "InstanceProtocol": "string",
      "LoadBalancerPort": 0,
      "Protocol": "string",
      "SSLCertificateId": "string"
    }
  ],
  "LoadBalancerName": "string"
}

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.

Parameters

Parameter In Type Required Description
LoadBalancerName body string true The name of the load balancer.
PolicyName body 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 body string true The name of the base policy type (only ProxyProtocolPolicyType is supported).

Body parameter

{
  "LoadBalancerName": "string",
  "PolicyName": "string",
  "PolicyTypeName": "string"
}

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.

Parameters

Parameter In Type Required Description
LoadBalancerName body string false The name of the load balancer.

Body parameter

{
  "LoadBalancerName": "string"
}

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.

Parameters

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

Body parameter

{
  "LoadBalancerName": "string",
  "LoadBalancerPorts.member": [
    0
  ]
}

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.

Parameters

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

Body parameter

{
  "LoadBalancerName": "string",
  "PolicyName": "string"
}

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.

Parameters

Parameter In Type Required Description
Instances.member body [Instances.member] false One or more instances.
» InstanceId body string false The ID of the instance.
LoadBalancerName body string false The name of the load balancer.

Body parameter

{
  "Instances.member": [
    {
      "InstanceId": "string"
    }
  ],
  "LoadBalancerName": "string"
}

Responses

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

Example responses

200 Response

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

DescribeInstanceHealth

GET /DescribeInstanceHealth

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

Parameters

Parameter In Type Required Description
Instances.member body [Instances.member] false One or more back-end instance IDs.
» InstanceId body string false The ID of the instance.
LoadBalancerName body string true The name of the load balancer.

Body parameter

{
  "Instances.member": [
    {
      "InstanceId": "string"
    }
  ],
  "LoadBalancerName": "string"
}

Responses

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

Example responses

200 Response

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

DescribeLoadBalancerAttributes

GET /DescribeLoadBalancerAttributes

Describes the attributes of the specified load balancer.

Parameters

Parameter In Type Required Description
LoadBalancerName body string false The name of the load balancer.

Body parameter

{
  "LoadBalancerName": "string"
}

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": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "ConnectionDraining": {
      "Enabled": true,
      "Timeout": 0
    },
    "ConnectionSettings": {
      "IdleTimeout": 0
    }
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeLoadBalancers

GET /DescribeLoadBalancers

Describes one or more load balancers.

Parameters

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

Body parameter

{
  "LoadBalancerNames.member": [
    "string"
  ],
  "Marker": "string",
  "PageSize": 0
}

Responses

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

Example responses

200 Response

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

ModifyLoadBalancerAttributes

GET /ModifyLoadBalancerAttributes

Modifies the specified attributes of a load balancer.

Parameters

Parameter In Type Required Description
LoadBalancerAttributes body LoadBalancerAttributes true The attributes of the load balancer.
» AccessLog body AccessLog false Information about the publication of the access logs.
»» EmitInterval body integer false The time interval for the publication of access logs in the Object Storage Unit (OSU) bucket, in minutes. This value can be either 5 or 60 (by default, 60).
»» Enabled body 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 body string false The name of the Object Storage Unit (OSU) bucket for the access logs.
»» S3BucketPrefix body string false The path to the folder of the access logs in your Object Storage Unit (OSU) bucket (by default, the root level of your bucket).
» AdditionalAttributes.member body [AdditionalAttributes.member] false Information about additional load balancer attributes, for example secure cookies.
»» Key body string false The name of the attribute.
»» Value body string false The value of the attribute.
» ConnectionDraining body ConnectionDraining false Information about the draining of the connections to unhealthy or deregistered instances.
»» Enabled body 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 body integer false The maximum time the load balancer keeps the existing connections open before deregistering instances, in seconds (by default, 20).
» ConnectionSettings body ConnectionSettings false Information about idle connections.
»» IdleTimeout body 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.
» LoadBalancerName body string true The name of the load balancer.

Detailed descriptions

»» Key: The name of the attribute.
You can configure secure cookies on your load balancer with SecuredCookies (secured_cookies in the response).

»» Value: The value of the attribute.
If the Key is SecuredCookies, set the Value to true to enable secure cookies and false to disable them.

»» IdleTimeout: 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.

Body parameter

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

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": [
      {
        "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 must be running in the same network as the load balancer (in the public Cloud or 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.

Parameters

Parameter In Type Required Description
Instances.member body [Instances.member] false One or more instances.
» InstanceId body string false The ID of the instance.
LoadBalancerName body string false The name of the load balancer.

Body parameter

{
  "Instances.member": [
    {
      "InstanceId": "string"
    }
  ],
  "LoadBalancerName": "string"
}

Responses

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

Example responses

200 Response

{
  "Instances.member": [
    {
      "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.

Parameters

Parameter In Type Required Description
LoadBalancerName body string true The name of the load balancer.
LoadBalancerPort body integer true The port using the SSL certificate.
SSLCertificateId body string true The Outscale Resource Name (ORN) of the SSL certificate.

Body parameter

{
  "LoadBalancerName": "string",
  "LoadBalancerPort": 0,
  "SSLCertificateId": "string"
}

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.

Parameters

Parameter In Type Required Description
InstancePort body integer true The port on which the instance is listening.
LoadBalancerName body string true The name of the load balancer.
PolicyNames.member body [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.

Body parameter

{
  "InstancePort": 0,
  "LoadBalancerName": "string",
  "PolicyNames.member": [
    "string"
  ]
}

Responses

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

Example responses

200 Response

{}

SetLoadBalancerPoliciesOfListener

GET /SetLoadBalancerPoliciesOfListener

Replaces the current set of policies for a load balancer with another specified one.
If the PolicyNames.member.N parameter is empty, all current policies are disabled.

Parameters

Parameter In Type Required Description
LoadBalancerName body string true The name of the load balancer.
LoadBalancerPort body integer true The external port of the load balancer.
PolicyNames.member body [string] true The list of policies names (must contain all the policies to be enabled).

Body parameter

{
  "LoadBalancerName": "string",
  "LoadBalancerPort": 0,
  "PolicyNames.member": [
    "string"
  ]
}

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.

Parameters

Parameter In Type Required Description
LoadBalancerNames.member body [string] true The name of a load balancer.
Tags.member body [Tags.member] true One or more tags you want to add to the load balancer.
» Key body string false The key of the tag, with a minimum of 1 character.
» Value body string false The value of the tag, with a minimum of 0 character.

Body parameter

{
  "LoadBalancerNames.member": [
    "string"
  ],
  "Tags.member": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

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.

Parameters

Parameter In Type Required Description
LoadBalancerNames.member body [string] true The name of one or more load balancers.

Body parameter

{
  "LoadBalancerNames.member": [
    "string"
  ]
}

Responses

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

Example responses

200 Response

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

RemoveTags

GET /RemoveTags

Deletes one or more tags from the specified load balancers.

Parameters

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

Body parameter

{
  "LoadBalancerNames.member": [
    "string"
  ],
  "Tags.member.N.Key": "string"
}

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 Object Storage Unit (OSU) 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 Object Storage Unit (OSU) bucket for the access logs.
S3BucketPrefix string false none The path to the folder of the access logs in your Object Storage Unit (OSU) 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

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

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

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 [string] false none The names of the policies enabled for the instance.

Schema

{
  "InstancePort": 0,
  "PolicyNames.member": [
    "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 [Instances.member] false none One or more instance IDs.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

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

DescribeInstanceHealthResponse

Properties

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

Schema

{
  "InstanceStates.member": [
    {
      "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": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "ConnectionDraining": {
      "Enabled": true,
      "Timeout": 0
    },
    "ConnectionSettings": {
      "IdleTimeout": 0
    }
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DescribeLoadBalancersResponse

Properties

Name Type Required Restrictions Description
LoadBalancerDescriptions.member [LoadBalancerDescriptions.member] 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": [
    {
      "AvailabilityZones.member": [
        "string"
      ],
      "BackendServerDescriptions.member": [
        {
          "InstancePort": 0,
          "PolicyNames.member": [
            "string"
          ]
        }
      ],
      "CreatedTime": "string",
      "DNSName": "string",
      "HealthCheck": {
        "HealthyThreshold": 0,
        "Interval": 0,
        "Target": "string",
        "Timeout": 0,
        "UnhealthyThreshold": 0
      },
      "Instances.member": [
        {
          "InstanceId": "string"
        }
      ],
      "ListenerDescriptions.member": [
        {
          "Listener": {
            "InstancePort": 0,
            "InstanceProtocol": "string",
            "LoadBalancerPort": 0,
            "Protocol": "string",
            "SSLCertificateId": "string"
          },
          "PolicyNames.member": [
            "string"
          ]
        }
      ],
      "LoadBalancerName": "string",
      "Policies": {
        "AppCookieStickinessPolicies.member": [
          {
            "CookieName": "string",
            "PolicyName": "string"
          }
        ],
        "LBCookieStickinessPolicies.member": [
          {
            "CookieExpirationPeriod": 0,
            "PolicyName": "string"
          }
        ],
        "OtherPolicies.member": [
          "string"
        ]
      },
      "Scheme": "string",
      "SecurityGroups.member": [
        "string"
      ],
      "SourceSecurityGroup": {
        "GroupName": "string",
        "OwnerAlias": "string"
      },
      "Subnets.member": [
        "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 [TagDescriptions.member] false none Information about the tags associated with the specified load balancers.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "TagDescriptions.member": [
    {
      "LoadBalancerName": "string",
      "Tags.member": [
        {
          "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, HTTPS or UDP.
- Port: Between 1 and 65535, both included.
- Path: The path for HTTP or HTTPS requests.
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

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

Information about one or more instances.

Properties

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

Schema

{
  "InstanceId": "string"
}

LBCookieStickinessPolicies.member

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 this parameter is not specified, 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 | UDP).
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 | UDP).
SSLCertificateId string false none The ID of the server certificate.

Schema

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

ListenerDescriptions.member

The listeners for the load balancer.

Properties

Name Type Required Restrictions Description
Listener Listener false none The listener.
PolicyNames.member [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": [
    "string"
  ]
}

Listeners.member

One or more listeners.

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 | UDP).
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 | UDP).
SSLCertificateId string false none The ID of the server certificate.

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 [AdditionalAttributes.member] 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": [
    {
      "Key": "string",
      "Value": "string"
    }
  ],
  "ConnectionDraining": {
    "Enabled": true,
    "Timeout": 0
  },
  "ConnectionSettings": {
    "IdleTimeout": 0
  }
}

LoadBalancerDescriptions.member

Information about one or more load balancers.

Properties

Name Type Required Restrictions Description
AvailabilityZones.member [string] false none The Availability Zones for the load balancer.
BackendServerDescriptions.member [BackendServerDescriptions.member] 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 [Instances.member] false none The IDs of the instances for the load balancer.
ListenerDescriptions.member [ListenerDescriptions.member] 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 a public IP address.
If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.
SecurityGroups.member [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 [string] false none The IDs of the subnets for the load balancer.
VPCId string false none The ID of the VPC for the load balancer.

Schema

{
  "AvailabilityZones.member": [
    "string"
  ],
  "BackendServerDescriptions.member": [
    {
      "InstancePort": 0,
      "PolicyNames.member": [
        "string"
      ]
    }
  ],
  "CreatedTime": "string",
  "DNSName": "string",
  "HealthCheck": {
    "HealthyThreshold": 0,
    "Interval": 0,
    "Target": "string",
    "Timeout": 0,
    "UnhealthyThreshold": 0
  },
  "Instances.member": [
    {
      "InstanceId": "string"
    }
  ],
  "ListenerDescriptions.member": [
    {
      "Listener": {
        "InstancePort": 0,
        "InstanceProtocol": "string",
        "LoadBalancerPort": 0,
        "Protocol": "string",
        "SSLCertificateId": "string"
      },
      "PolicyNames.member": [
        "string"
      ]
    }
  ],
  "LoadBalancerName": "string",
  "Policies": {
    "AppCookieStickinessPolicies.member": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "LBCookieStickinessPolicies.member": [
      {
        "CookieExpirationPeriod": 0,
        "PolicyName": "string"
      }
    ],
    "OtherPolicies.member": [
      "string"
    ]
  },
  "Scheme": "string",
  "SecurityGroups.member": [
    "string"
  ],
  "SourceSecurityGroup": {
    "GroupName": "string",
    "OwnerAlias": "string"
  },
  "Subnets.member": [
    "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": [
      {
        "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 [AppCookieStickinessPolicies.member] false none The stickiness policies created using CreateAppCookieStickinessPolicy.
LBCookieStickinessPolicies.member [LBCookieStickinessPolicies.member] false none The stickiness policies created using CreateLBCookieStickinessPolicy.
OtherPolicies.member [string] false none The policies other than the stickiness policies.

Schema

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

RegisterInstancesWithLoadBalancerResponse

Properties

Name Type Required Restrictions Description
Instances.member [Instances.member] false none One or more instance IDs.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Instances.member": [
    {
      "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

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 [Tags.member] false none One or more tags associated with the load balancer.

Schema

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

Tags.member

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 ©2020 Outscale SAS. All rights reserved