• Buy Now
    • Rackspace Cloud
    • Email & Apps
    • Fanatical Support for AWS
    • Managed Google Cloud Platform
    • Office 365
  • Log In
    • MyRackspace Portal
    • Cloud Control Panel
    • Rackspace Webmail Login
    • Cloud Office Control Panel
  • Rackspace Logo
  • Developer Home
  • Developer Documentation
  • Blogs ▼
    • Technical Blog
    • Rackspace Blog
  • Support Documentation

Developer Docs


Let’s Build Something Powerful Together!

Submit an issue
  • Cloud Load Balancers 1.0
  • Getting started
    • Get your credentials
    • Sending API requests to Cloud Load Balancers
      • Convert cURL examples to run on Windows
    • Authenticate to the Rackspace Cloud
      • Send an authentication request
      • Review the authentication response
      • Configure environment variables
    • Load balancer concepts
      • Load balancer
      • Virtual IP
      • Error page
      • Node
      • Health monitor
      • Session persistence
      • Connection logging
    • Create and manage Cloud Load Balancers
      • Creating Cloud Servers
      • Creating a Load Balancer
      • Listing Load Balancer details
      • Adding a node
      • Updating Load Balancer attributes
  • General API information
    • Service access endpoints
    • Request and response types
    • Content compression
    • Persistent connections
    • Paginated collections
    • Limits
      • Rate limits
      • Absolute limits
      • Retrieve account limits
    • Faults
      • serviceFault
      • badRequest
      • immutableEntity
      • itemNotFound
      • loadBalancerFault
      • outOfVirtualIps
      • overLimit
      • serviceUnavailable
      • unauthorized
      • unprocessableEntity
    • Date and time format
    • API behavior and statuses
    • Compatible shared load balancing protocols
      • DNS-compatible load balancing protocols
      • TCP- and UDP-compatible load balancing protocols
    • Role-based access control (RBAC)
      • Assigning roles to account users
      • Roles available for Rackspace Cloud Load Balancers
      • Multiproduct global roles and permissions
      • Resolving conflicts between RBAC multiproduct and product-specific roles
      • RBAC permissions cross-reference to Rackspace Cloud Load Balancers API operations
  • API reference
    • Load balancers
      • List load balancers
      • Create load balancer
      • Bulk-delete load balancers
      • Show load balancer details
      • Update load balancer properties
      • Delete load balancer
    • Error pages
      • Show custom error page
      • Set custom error page
      • Delete custom error page
    • Load balancer statistics
      • Show load balancer statistics
    • Nodes
      • List nodes
      • Add node
      • Bulk-delete nodes
      • Show node details
      • Update node
      • Delete node
      • List node service events
    • Virtual IPs
      • List virtual IPs
      • Add virtual IP version 6
      • Bulk-delete virtual IPs
      • Delete virtual IP
    • Allowed domains
      • List allowed domains
    • Usage reports
      • Show historical usage
      • Show account-level usage
      • Show current usage
      • List billable load balancers
    • Access lists
      • Show access list
      • Create or update access list
      • Delete access list
      • Bulk-delete networks from access list
      • Delete network from access list
    • Monitors
      • Show health monitor configuration
      • Update health monitor
      • Delete health monitor
    • Session persistence
      • Show session persistence configuration
      • Enable session persistence
      • Disable session persistence
    • Log connections
      • Show connection logging configuration
      • Enable or disable connection logging
    • Throttle connections
      • Show connection throttling configuration
      • Create or update connection throttling configuration
      • Delete connection throttling configuration
    • Content caching
      • Show content caching configuration
      • Enable content caching
    • Protocols
      • List load balancing protocols
    • Algorithms
      • List load balancing algorithms
    • SSL termination
      • Show SSL termination configuration
      • Update SSL termination configuration
      • Delete SSL termination
    • Certificate mappings
      • List certificate mappings
      • Add certificate mapping
      • Show certificate mappings details
      • Update certificate mapping
      • Delete certificate mapping
    • Ciphers
      • Cipher profiles
      • List ciphers
    • Metadata
      • Add load balancer metadata
      • Show load balancer metadata
      • Bulk-delete load balancer metadata items
      • Show load balancer metadata item
      • Update load balancer metadata item
      • Delete load balancer metadata item
      • Show load balancer node metadata
      • Add load balancer node metadata item
      • Bulk-delete load balancer node metadata items
      • Show load balancer node metadata item
      • Update load balancer node metadata item
      • Delete load balancer node metadata item
  • Release notes
    • v1.26.27, Oct 22nd, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.23, Sep 18th, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.17, Jul 10th, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.15, Jun 4th, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.13, May 22nd, 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.26.10, April 1st 2019
      • What's new
      • Resolved issues
      • Known issues
    • v1.25.56, March 13th 2018
      • What's new
      • Resolved issues
      • Known issues
    • API 1.0 updates, August 23, 2016
      • What's new
      • Resolved issues
      • Known issues
    • API 1.0 updates, June 29, 2016
      • What's new
      • Resolved issues
      • Known issues
    • v1.25.26, February 5, 2016
      • What's new
      • Resolved issues
      • Known issues
    • v1.23.7, October 7, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.22.10, August 1, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.21.14, June 17, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.21.12, June 6, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.20.22, March 24, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.19.32, February 26, 2014
      • What's new
      • Resolved issues
      • Known issues
  • Additional resources
  • Disclaimer

Error pages¶

  • Show custom error page
  • Set custom error page
  • Delete custom error page

An error page is the HTML file that is shown to an end user who is attempting to access a load balancer node that is offline/unavailable.

During provisioning, every load balancer is configured with a default error page that gets displayed when traffic is requested for an offline node.

You can add a single custom error page with an HTTP-based protocol to a load balancer. Page updates override existing content. If a custom error page is deleted, or the load balancer is changed to a non-HTTP protocol, the default error page is restored.

Show custom error page¶

GET /v1.0/{account}/loadbalancers/{loadBalancerId}/errorpage

Shows the custom error page that is configured for a specified load balancer.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.

The following table shows the body parameters for the request:

Name Type Description
content String (Required) The HTML content for the custom error page. Must be 65536 characters or fewer. See the request examples in this section for the required XML and JSON formats.

Response¶

Example Show custom error page: JSON response

{"errorpage":
    {"content":"<html> DEFAULT ERROR PAGE</html>"}
}

Example Show custom error page: XML response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorpage xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <content>
               <html> DEFAULT ERROR PAGE
               </html>
    </content>
</errorpage>

Set custom error page¶

PUT /v1.0/{account}/loadbalancers/{loadBalancerId}/errorpage

Sets a custom error page for a specified load balancer.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.

The following table shows the body parameters for the request:

Name Type Description
content String (Required) The HTML content for the custom error page. Must be 65536 characters or fewer. See the request examples in this section for the required XML and JSON formats.

Example Set custom error page: JSON request

{"errorpage":
{"content":"\n<html>\n    DEFAULT ERROR PAGE\n</html>\n"}
}

Example Set custom error page: XML request

<errorpage xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <content>
              <![CDATA[
               <html> DEFAULT ERROR PAGE
               </html>
       ]]>
    </content>
</errorpage>

Response¶

Example Set custom error page: JSON response

{"errorpage":
    {"content":"<html> DEFAULT ERROR PAGE</html>"}
}

Example Set custom error page: XML response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorpage xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <content>
               <html> DEFAULT ERROR PAGE
               </html>
    </content>
</errorpage>

Delete custom error page¶

DELETE /v1.0/{account}/loadbalancers/{loadBalancerId}/errorpage

Deletes the custom error page for a specified load balancer.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 Success Request succeeded.
400 Bad Request The request is missing one or more elements, or the values of some elements are invalid.
401 Unauthorized You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404 Not Found The requested item was not found.
413 Over Limit The number of items returned is above the allowed limit.
422 ImmutableEntity This fault is returned when a user attempts to modify an item that is not currently in a state that allows modification. For example, load balancers in a status of PENDING_UPDATE,BUILD, or DELETED may not be modified.
500 Load Balancer Fault The load balancer has experienced a fault.
503 Service Unavailable The service is not available.

Request¶

The following table shows the URI parameters for the request:

Name Type Description
{account} String The ID for the tenant or account in a multi- tenancy cloud.
{loadBalancerId} String The ID for the load balancer.

This operation does not accept a request body.

Response¶

This operation does not return a response body.

Previous Load balancers
Next Load balancer statistics
Docs
  • Style Guide for Technical Content
  • Cloud Backup
  • Cloud Block Storage
  • Cloud Databases
  • Cloud DNS
  • Cloud Files
  • Identity
  • Cloud Images
  • Cloud Load Balancers
  • Cloud Monitoring
  • Cloud Orchestration
  • Cloud Networks
  • Cloud Queues
  • Cloud Servers
  • Rackspace Auto Scale
  • Rackspace CDN
Sdks
  • Go
  • Java
  • .Net
  • Node
  • PHP
  • Python
  • Ruby
Partner Tools
  • Airbrake
  • Mailgun
  • ObjectRocket
  • RedisToGo
Blog
  • Technical Blog
  • Rackspace Blog
©2019 Rackspace US, Inc.
  • ©2019 Rackspace US, Inc.
  • About Rackspace
  • Investors
  • Careers
  • Privacy Statement
  • Website Terms
  • Trademarks