Documentation Powered by ReDoc

Managed Load Balancer API Reference (1.3.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: © NTT DOCOMO BUSINESS, Inc. All Rights Reserved Terms of Service

Introduction

This manual explains how to use the Smart Data Platform Managed Load Balancer API

Notes

  • Field names in HTTP response header are case-insensitive

Certificates

The Certificates API provides a feature to upload your TLS certificate files

List Certificates

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
details
boolean
Default: false
  • If true is set, information of the certificate file are displayed
ca_cert_status
string
Enum: "UPLOADED" "NOT_UPLOADED"
  • CA certificate file upload status of the certificate
ssl_cert_status
string
Enum: "UPLOADED" "NOT_UPLOADED"
  • SSL certificate file upload status of the certificate
ssl_key_status
string
Enum: "UPLOADED" "NOT_UPLOADED"
  • SSL key file upload status of the certificate
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/certificates
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/certificates

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificates":
    [
    ]
}

Create Certificate

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
certificate
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/certificates
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/certificates

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificate":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificate":
    {
    }
}

Show Certificate

path Parameters
certificate_id
required
string <uuid>
  • ID of the certificate
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/certificates/{certificate_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/certificates/{certificate_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificate":
    {
    }
}

Update Certificate

path Parameters
certificate_id
required
string <uuid>
  • ID of the certificate
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
certificate
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/certificates/{certificate_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/certificates/{certificate_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificate":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "certificate":
    {
    }
}

Delete Certificate

path Parameters
certificate_id
required
string <uuid>
  • ID of the certificate
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/certificates/{certificate_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/certificates/{certificate_id}

Upload Certificate File

path Parameters
certificate_id
required
string <uuid>
  • ID of the certificate
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
type
required
string
Enum: "ca-cert" "ssl-cert" "ssl-key"
  • Type of the certificate file to be uploaded
  • Can be uploaded only once for each type
content
required
string
  • Content of the certificate file to be uploaded
  • The content must be Base64 encoded
    • The file size before encoding must be less than or equal to 16KB
    • The file format before encoding must be PEM
      • DER can be converted to PEM by using OpenSSL command
  • The following key algorithms are supported
    • RSA 1024, 2048, 3072 and 4096 bits
    • ECDSA P-256 (prime256v1, secp256r1), P-384 (secp384r1) and P-521 (secp521r1)
  • The content of "ssl-cert" and the content of "ssl-key" must be a pair (must be matched correctly)
passphrase
string [ 0 .. 128 ] characters
  • Passphrase of the certificate file to be uploaded
  • This parameter can be set when 'type' is "ssl-key"

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/certificates/{certificate_id}/files
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/certificates/{certificate_id}/files

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "ssl-key",
  • "content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCjAxMjM0NTY3ODlBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEKMjM0NTY3ODlBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMwo0NTY3ODlBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1CjY3ODlBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1NjcKODlBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OQpBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCCkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0QKRUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRgpHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdICklKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUoKS0xNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTApNTk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OCk9QUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1AKUVJTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1BRUgpTVFVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1BRUlNUClVWV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1BRUlNUVVYKV1hZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1BRUlNUVVZXWApZWmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1BRUlNUVVZXWFlaCmFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1BRUlNUVVZXWFlaYWIKY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6MDEyMzQ1Njc4OUFCQ0RFRkdISUpLTE1OT1BRUlNUVVZXWFlaYWJjZAplZmdoaWprbG1ub3BxcnN0dXZ3eHl6VjAxMjM0NTY3ODlBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWmFiY2RlCmZnaGlqa2xtbm9wcXJzdHV2d3h5ejAxMgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==",
  • "passphrase": "passphrase"
}

Health Monitors

The Health Monitors API provides configurations of a feature to periodically check status of members of a target group to determine whether a member is available to handle requests

List Health Monitors

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
configuration_status
string
Enum: "ACTIVE" "CREATE_STAGED" "UPDATE_STAGED" "DELETE_STAGED"
  • Configuration status of the resource
operation_status
string
Enum: "NONE" "PROCESSING" "COMPLETE" "STUCK" "ERROR"
  • Operation status of the resource
port
integer [ 1 .. 65534 ]
  • Port number of the resource for healthchecking or listening
protocol
string
Enum: "icmp" "tcp" "http" "https"
  • Protocol of the resource for healthchecking or listening
interval
integer [ 1 .. 180 ]
  • Interval of healthchecking (in seconds)
retry
integer [ 1 .. 10 ]
  • Retry count of healthchecking
timeout
integer [ 1 .. 180 ]
  • Timeout of healthchecking (in seconds)
path
string [ 0 .. 500 ] characters
  • URL path of healthchecking
  • Must be started with "/"
http_status_code
string
  • HTTP status codes expected in healthchecking
  • Format: "xxx" or "xxx-xxx" ( xxx between [100, 599])
load_balancer_id
string <uuid>
  • ID of the load balancer which the resource belongs to
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/health_monitors
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitors":
    [
    ]
}

Create Health Monitor

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
health_monitor
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/health_monitors
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Show Health Monitor

path Parameters
health_monitor_id
required
string <uuid>
  • ID of the health monitor
query Parameters
changes
boolean
  • If true is set, current and staged are returned in response body
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/health_monitors/{health_monitor_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors/{health_monitor_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Update Health Monitor Attributes

path Parameters
health_monitor_id
required
string <uuid>
  • ID of the health monitor
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
health_monitor
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/health_monitors/{health_monitor_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors/{health_monitor_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Delete Health Monitor

path Parameters
health_monitor_id
required
string <uuid>
  • ID of the health monitor
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/health_monitors/{health_monitor_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors/{health_monitor_id}

Create Staged Health Monitor Configurations

path Parameters
health_monitor_id
required
string <uuid>
  • ID of the health monitor
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
health_monitor
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/health_monitors/{health_monitor_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors/{health_monitor_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Show Staged Health Monitor Configurations

path Parameters
health_monitor_id
required
string <uuid>
  • ID of the health monitor
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/health_monitors/{health_monitor_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors/{health_monitor_id}/staged

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Update Staged Health Monitor Configurations

path Parameters
health_monitor_id
required
string <uuid>
  • ID of the health monitor
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
health_monitor
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/health_monitors/{health_monitor_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors/{health_monitor_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "health_monitor":
    {
    }
}

Cancel Staged Health Monitor Configurations

path Parameters
health_monitor_id
required
string <uuid>
  • ID of the health monitor
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/health_monitors/{health_monitor_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/health_monitors/{health_monitor_id}/staged

Listeners

The Listeners API provides configurations of a feature to receive connection requests using a IP address, port number, and protocol

List Listeners

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
configuration_status
string
Enum: "ACTIVE" "CREATE_STAGED" "UPDATE_STAGED" "DELETE_STAGED"
  • Configuration status of the resource
operation_status
string
Enum: "NONE" "PROCESSING" "COMPLETE" "STUCK" "ERROR"
  • Operation status of the resource
ip_address
string <ipv4>
  • IP address of the resource for listening
port
integer [ 1 .. 65534 ]
  • Port number of the resource for healthchecking or listening
protocol
string
Enum: "tcp" "udp" "http" "https"
  • Protocol of the resource for healthchecking or listening
load_balancer_id
string <uuid>
  • ID of the load balancer which the resource belongs to
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/listeners
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listeners":
    [
    ]
}

Create Listener

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
listener
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/listeners
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Show Listener

path Parameters
listener_id
required
string <uuid>
  • ID of the listener
query Parameters
changes
boolean
  • If true is set, current and staged are returned in response body
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/listeners/{listener_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners/{listener_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Update Listener Attribute

path Parameters
listener_id
required
string <uuid>
  • ID of the listener
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
listener
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/listeners/{listener_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners/{listener_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Delete Listener

path Parameters
listener_id
required
string <uuid>
  • ID of the listener
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/listeners/{listener_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners/{listener_id}

Create Staged Listener Configurations

path Parameters
listener_id
required
string <uuid>
  • ID of the listener
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
listener
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/listeners/{listener_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners/{listener_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Show Staged Listener Configurations

path Parameters
listener_id
required
string <uuid>
  • ID of the listener
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/listeners/{listener_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners/{listener_id}/staged

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Update Staged Listener Configurations

path Parameters
listener_id
required
string <uuid>
  • ID of the listener
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
listener
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/listeners/{listener_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners/{listener_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "listener":
    {
    }
}

Cancel Staged Listener Configurations

path Parameters
listener_id
required
string <uuid>
  • ID of the listener
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/listeners/{listener_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/listeners/{listener_id}/staged

Load Balancers

The Load Balancers API provides features to connect or disconnect logical networks and perform actions such as applying configurations

List Load Balancers

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
configuration_status
string
Enum: "ACTIVE" "CREATE_STAGED" "UPDATE_STAGED" "DELETE_STAGED"
  • Configuration status of the resource
monitoring_status
string
Enum: "ACTIVE" "INITIAL" "UNAVAILABLE"
  • Monitoring status of the load balancer
operation_status
string
Enum: "NONE" "PROCESSING" "COMPLETE" "STUCK" "ERROR"
  • Operation status of the resource
primary_availability_zone
string
  • The zone / group where the primary virtual server of load balancer is deployed
secondary_availability_zone
string
  • The zone / group where the secondary virtual server of load balancer is deployed
active_availability_zone
string
  • Primary or secondary availability zone where the load balancer is currently running
revision
integer
  • Revision of the load balancer
plan_id
string <uuid>
  • ID of the plan
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/load_balancers
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancers":
    [
    ]
}

Create Load Balancer

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
load_balancer
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/load_balancers
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Show Load Balancer

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
query Parameters
changes
boolean
  • If true is set, current and staged are returned in response body
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/load_balancers/{load_balancer_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Update Load Balancer Attributes

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
load_balancer
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/load_balancers/{load_balancer_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Delete Load Balancer

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
header Parameters
X-Auth-Token
required
string
X-MVNA-Request-Id
string <uuid>
  • By assigning a request_id in this parameter, the request is processed only once, enabling the client to safely retry requests
    • During retry requests, the client will receive a 204 response
  • Field names in HTTP request header are case-insensitive

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/load_balancers/{load_balancer_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}

Create Staged Load Balancer Configurations

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
load_balancer
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/load_balancers/{load_balancer_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Show Staged Load Balancer Configurations

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/load_balancers/{load_balancer_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}/staged

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Update Staged Load Balancer Configurations

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
load_balancer
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/load_balancers/{load_balancer_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "load_balancer":
    {
    }
}

Cancel Staged Load Balancer Configurations

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/load_balancers/{load_balancer_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}/staged

Action Load Balancer

path Parameters
load_balancer_id
required
string <uuid>
  • ID of the load balancer
header Parameters
X-Auth-Token
required
string
X-MVNA-Request-Id
string <uuid>
  • By assigning a request_id in this parameter, the request is processed only once, enabling the client to safely retry requests
    • During retry requests, the client will receive a 204 response
  • Field names in HTTP request header are case-insensitive
Request Body schema: application/json
One of
  • object
  • object
apply-configurations
object
Default: null
  • Added or changed configurations of the load balancer and related resources will be applied
  • Must be set null
system-update
object
  • Apply the system update to the load balancer

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/load_balancers/{load_balancer_id}/action
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/load_balancers/{load_balancer_id}/action

Request samples

Content type
application/json
Example
apply-configurations
Copy
 Expand all Collapse all
{
  • "apply-configurations": null
}

Operations

The Operations API provides history of operations (such as an action) performed for the load balancer

List Operations

query Parameters
id
string <uuid>
  • ID of the resource
resource_id
string <uuid>
  • ID of the resource
resource_type
string
Value: "ECL::ManagedLoadBalancer::LoadBalancer"
  • Type of the resource
request_id
string <uuid>
  • The unique hyphenated UUID to identify the request
    • The UUID which has been set by X-MVNA-Request-Id in request headers
request_type
string
Enum: "Action::apply-configurations" "Action::cancel-configurations" "Action::system-update" "Action::re-create" "Delete"
  • Type of the request
status
string
Enum: "PROCESSING" "COMPLETE" "ERROR" "STUCK"
  • Operation status of the resource
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
no_deleted
boolean
Default: false
  • If true is set, operations of deleted resource is not displayed
latest
boolean
Default: false
  • If true is set, only the latest operation of each resource is displayed
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/operations
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/operations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "operations":
    [
    ]
}

Show Operation

path Parameters
operation_id
required
string <uuid>
  • ID of the operation
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/operations/{operation_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/operations/{operation_id}

Response samples

Content type
application/json
Example
Action::apply-configurations
Copy
 Expand all Collapse all
{
  • "operation":
    {
    }
}

Plans

The Plans API provides information of plans such as bandwidth, redundancy and max number of resources which belong to the load balancer

List Plans

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts single-byte characters only
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts single-byte characters only
bandwidth
string
Enum: "50M" "200M" "1000M" "3000M"
  • Bandwidth of the plan
redundancy
string
Enum: "HA" "SINGLE"
  • Redundancy of the plan
max_number_of_interfaces
integer
  • Maximum number of interfaces for the plan
max_number_of_health_monitors
integer
  • Maximum number of health monitors for the plan
max_number_of_listeners
integer
  • Maximum number of listeners for the plan
max_number_of_policies
integer
  • Maximum number of policies for the plan
max_number_of_routes
integer
  • Maximum number of routes for the plan
max_number_of_target_groups
integer
  • Maximum number of target groups for the plan
max_number_of_members
integer
  • Maximum number of members for the target group of the plan
max_number_of_rules
integer
  • Maximum number of rules for the policy of the plan
max_number_of_conditions
integer
  • Maximum number of conditions in the rule of the plan
max_number_of_server_name_inidications
integer
  • Maximum number of Server Name Indications (SNIs) for the policy of the plan
enabled
boolean
  • Whether a new load balancer can be created with this plan
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/plans
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/plans

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "plans":
    [
    ]
}

Show Plan

path Parameters
plan_id
required
string <uuid>
  • ID of the plan
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/plans/{plan_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/plans/{plan_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "plan":
    {
    }
}

Policies

The Policies API provides features to specify load balancing algorithm and persistence method, etc. and associate other resources (such as a health monitor, listener, and target group)

List Policies

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
configuration_status
string
Enum: "ACTIVE" "CREATE_STAGED" "UPDATE_STAGED" "DELETE_STAGED"
  • Configuration status of the resource
operation_status
string
Enum: "NONE" "PROCESSING" "COMPLETE" "STUCK" "ERROR"
  • Operation status of the resource
algorithm
string
Enum: "round-robin" "weighted-round-robin" "least-connection" "weighted-least-connection" "source-ip-port-hash"
  • Load balancing algorithm (method) of the policy
persistence
string
Enum: "none" "source-ip" "cookie"
  • Persistence setting of the policy
persistence_timeout
integer [ 0 .. 525600 ]
  • If persistence is "source-ip"
    • The timeout (in minutes) during which the persistence remain after the latest traffic from the client is sent to the load balancer
  • If persistence is "cookie"
    • The expiration (in minutes) of the persistence set in the cookie that the load balancer returns to the client
idle_timeout
integer [ 1 .. 10800 ]
  • The timeout (in seconds) during which a session is allowed to remain inactive
sorry_page_url
string <uri> [ 0 .. 255 ] characters
  • URL of the sorry page to which accesses are redirected if all members in the target group are down
source_nat
string
Enum: "enable" "disable"
  • Source NAT setting of the policy
certificate_id
string <uuid>
  • ID of the certificate that assigned to the policy
  • Also includes certificate contained in server_name_indications
health_monitor_id
string <uuid>
  • ID of the health monitor that assigned to the policy
listener_id
string <uuid>
  • ID of the listener that assigned to the policy
default_target_group_id
string <uuid>
  • ID of the default target group that assigned to the policy
backup_target_group_id
string <uuid>
  • ID of the backup target group that assigned to the policy
  • If all members of the default target group are down, traffic is routed to the backup target group
tls_policy_id
string <uuid>
  • ID of the TLS policy that assigned to the policy
load_balancer_id
string <uuid>
  • ID of the load balancer which the resource belongs to
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/policies
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policies":
    [
    ]
}

Create Policy

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
policy
required
object
  • The load balancer can be configured with up to 100 policies and rules combined
    • The total count of policy and rule configurations must not exceed 100

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/policies
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Show Policy

path Parameters
policy_id
required
string <uuid>
  • ID of the policy
query Parameters
changes
boolean
  • If true is set, current and staged are returned in response body
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/policies/{policy_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies/{policy_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Update Policy Attributes

path Parameters
policy_id
required
string <uuid>
  • ID of the policy
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
policy
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/policies/{policy_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies/{policy_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Delete Policy

path Parameters
policy_id
required
string <uuid>
  • ID of the policy
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/policies/{policy_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies/{policy_id}

Create Staged Policy Configurations

path Parameters
policy_id
required
string <uuid>
  • ID of the policy
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
policy
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/policies/{policy_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies/{policy_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Show Staged Policy Configurations

path Parameters
policy_id
required
string <uuid>
  • ID of the policy
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/policies/{policy_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies/{policy_id}/staged

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Update Staged Policy Configurations

path Parameters
policy_id
required
string <uuid>
  • ID of the policy
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
policy
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/policies/{policy_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies/{policy_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policy":
    {
    }
}

Cancel Staged Policy Configurations

path Parameters
policy_id
required
string <uuid>
  • ID of the policy
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/policies/{policy_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/policies/{policy_id}/staged

Routes

The Routes API provides a feature to configure static routes for the load balancer

List Routes

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
configuration_status
string
Enum: "ACTIVE" "CREATE_STAGED" "UPDATE_STAGED" "DELETE_STAGED"
  • Configuration status of the resource
operation_status
string
Enum: "NONE" "PROCESSING" "COMPLETE" "STUCK" "ERROR"
  • Operation status of the resource
destination_cidr
string
  • CIDR of destination for the (static) route
next_hop_ip_address
string <ipv4>
  • IP address of next hop for the (static) route
load_balancer_id
string <uuid>
  • ID of the load balancer which the resource belongs to
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/routes
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "routes":
    [
    ]
}

Create Route

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
route
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/routes
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Show Route

path Parameters
route_id
required
string <uuid>
  • ID of the (static) route
query Parameters
changes
boolean
  • If true is set, current and staged are returned in response body
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/routes/{route_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes/{route_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Update Route Attributes

path Parameters
route_id
required
string <uuid>
  • ID of the (static) route
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
route
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/routes/{route_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes/{route_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Delete Route

path Parameters
route_id
required
string <uuid>
  • ID of the (static) route
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/routes/{route_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes/{route_id}

Create Staged Route Configurations

path Parameters
route_id
required
string <uuid>
  • ID of the (static) route
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
route
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/routes/{route_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes/{route_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Show Staged Route Configurations

path Parameters
route_id
required
string <uuid>
  • ID of the (static) route
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/routes/{route_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes/{route_id}/staged

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Update Staged Route Configurations

path Parameters
route_id
required
string <uuid>
  • ID of the (static) route
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
route
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/routes/{route_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes/{route_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "route":
    {
    }
}

Cancel Staged Route Configurations

path Parameters
route_id
required
string <uuid>
  • ID of the (static) route
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/routes/{route_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/routes/{route_id}/staged

Rules

The Rules API provides configurations of a feature to distribute requests to target groups by defined conditions (such as URL path patterns)

List Rules

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
configuration_status
string
Enum: "ACTIVE" "CREATE_STAGED" "UPDATE_STAGED" "DELETE_STAGED"
  • Configuration status of the resource
operation_status
string
Enum: "NONE" "PROCESSING" "COMPLETE" "STUCK" "ERROR"
  • Operation status of the resource
priority
integer [ 1 .. 1000 ]
  • Priority of the rule
target_group_id
string <uuid>
  • ID of the target group that assigned to the rule
  • If all members of the target groups specified in the rule are down, traffic is routed to the target groups specified in the policy
backup_target_group_id
string <uuid>
  • ID of the backup target group that assigned to the rule
  • If all members of the target group are down, traffic is routed to the backup target group
  • If all members of the target groups specified in the rule are down, traffic is routed to the target groups specified in the policy
policy_id
string <uuid>
  • ID of the policy which the rule belongs to
load_balancer_id
string <uuid>
  • ID of the load balancer which the resource belongs to
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/rules
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rules":
    [
    ]
}

Create Rule

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
rule
required
object
  • The load balancer can be configured with up to 100 policies and rules combined
    • The total count of policy and rule configurations must not exceed 100

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/rules
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Show Rule

path Parameters
rule_id
required
string <uuid>
  • ID of the rule
query Parameters
changes
boolean
  • If true is set, current and staged are returned in response body
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/rules/{rule_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules/{rule_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Update Rule Attributes

path Parameters
rule_id
required
string <uuid>
  • ID of the rule
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
rule
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/rules/{rule_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules/{rule_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Delete Rule

path Parameters
rule_id
required
string <uuid>
  • ID of the rule
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/rules/{rule_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules/{rule_id}

Create Staged Rule Configurations

path Parameters
rule_id
required
string <uuid>
  • ID of the rule
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
rule
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/rules/{rule_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules/{rule_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Show Staged Rule Configurations

path Parameters
rule_id
required
string <uuid>
  • ID of the rule
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/rules/{rule_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules/{rule_id}/staged

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Update Staged Rule Configurations

path Parameters
rule_id
required
string <uuid>
  • ID of the rule
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
rule
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/rules/{rule_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules/{rule_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rule":
    {
    }
}

Cancel Staged Rule Configurations

path Parameters
rule_id
required
string <uuid>
  • ID of the rule
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/rules/{rule_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/rules/{rule_id}/staged

System Updates

The System Updates API provides information of updates for load balancers which purpose is applying security patches and adding new features

List System Updates

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts single-byte characters only
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts single-byte characters only
href
string <uri> [ 0 .. 255 ] characters
  • URL of announcement for the system update (for example, Knowledge Center news)
current_revision
integer
  • Current revision for the system update
next_revision
integer
  • Next revision for the system update
applicable
boolean
  • Whether the system update can be applied to the load balancer
latest
boolean
Default: false
  • If true is set, only the latest resource is displayed
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/system_updates
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/system_updates

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "system_updates":
    [
    ]
}

Show System Update

path Parameters
system_update_id
required
string <uuid>
  • ID of the system update
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/system_updates/{system_update_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/system_updates/{system_update_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "system_update":
    {
    }
}

Target Groups

The Target Groups API provides configurations of a feature to group load balancing targets (real servers)

List Target Groups

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts UTF-8 characters up to 3 bytes
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts UTF-8 characters up to 3 bytes
configuration_status
string
Enum: "ACTIVE" "CREATE_STAGED" "UPDATE_STAGED" "DELETE_STAGED"
  • Configuration status of the resource
operation_status
string
Enum: "NONE" "PROCESSING" "COMPLETE" "STUCK" "ERROR"
  • Operation status of the resource
load_balancer_id
string <uuid>
  • ID of the load balancer which the resource belongs to
tenant_id
string <uuid>
  • ID of the owner tenant of the resource
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/target_groups
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_groups":
    [
    ]
}

Create Target Group

header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
target_group
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1.0/target_groups
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Show Target Group

path Parameters
target_group_id
required
string <uuid>
  • ID of the target group
query Parameters
changes
boolean
  • If true is set, current and staged are returned in response body
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/target_groups/{target_group_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups/{target_group_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Update Target Group Attributes

path Parameters
target_group_id
required
string <uuid>
  • ID of the target group
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
target_group
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/target_groups/{target_group_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups/{target_group_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Delete Target Group

path Parameters
target_group_id
required
string <uuid>
  • ID of the target group
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/target_groups/{target_group_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups/{target_group_id}

Create Staged Target Group Configurations

path Parameters
target_group_id
required
string <uuid>
  • ID of the target group
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
target_group
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1.0/target_groups/{target_group_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups/{target_group_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Show Staged Target Group Configurations

path Parameters
target_group_id
required
string <uuid>
  • ID of the target group
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/target_groups/{target_group_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups/{target_group_id}/staged

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Update Staged Target Group Configurations

path Parameters
target_group_id
required
string <uuid>
  • ID of the target group
header Parameters
X-Auth-Token
required
string
Request Body schema: application/json
target_group
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1.0/target_groups/{target_group_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups/{target_group_id}/staged

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "target_group":
    {
    }
}

Cancel Staged Target Group Configurations

path Parameters
target_group_id
required
string <uuid>
  • ID of the target group
header Parameters
X-Auth-Token
required
string

Responses

204

No Content

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1.0/target_groups/{target_group_id}/staged
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/target_groups/{target_group_id}/staged

TLS Policies

The TLS Policies API provides information of combinations of protocols and ciphers used for negotiating TLS connections between a client and a load balancer

List TLS Policies

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
  • This field accepts single-byte characters only
description
string [ 0 .. 255 ] characters
  • Description of the resource
  • This field accepts single-byte characters only
default
boolean
  • Whether the TLS policy will be set policy.tls_policy_id when that is not specified
header Parameters
X-Auth-Token
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1.0/tls_policies
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/tls_policies

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tls_policies":
    [
    ]
}

Show TLS Policy

path Parameters
tls_policy_id
required
string <uuid>
  • ID of the TLS policy
header Parameters
X-Auth-Token
required
string

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1.0/tls_policies/{tls_policy_id}
https://managed-load-balancer-{region}-ecl.api.ntt.com/v1.0/tls_policies/{tls_policy_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tls_policy":
    {
    }
}