Managed Load Balancer API Reference (1.0.0)

Download OpenAPI specification:Download

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

health_monitors

List Health Monitors

query Parameters
id
string <uuid>
  • ID of the resource
name
string [ 0 .. 255 ] characters
  • Name of the resource
description
string [ 0 .. 255 ] characters
  • Description of the resource
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"
  • 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)
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
  • When true is specified, 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