Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

XSKY s3-load-balancers API

S3LoadBalancerController API

XSKY s3-load-balancers API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include s3-load-balancers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 2.0, at version SDS_4.2.000.0.200302.

Requests are made against the base URL https://{xms-controller}/v1.

4 operations 4 paths 12 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
SDS_4.2.000.0.200302
Base URL
https://{xms-controller}/v1
Authentication
API Key, API Key
License
Commercial
Resource Areas
1

Authentication & Security 2

XSKY s3-load-balancers API declares 2 security schemes for authenticating requests. An API key is passed in the header as Xms-Auth-Token (tokenInHeader). An API key is passed in the query as token (tokenInQuery).

  • tokenInHeader — auth by token
  • tokenInQuery — auth by token

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

s3-load-balancers 4

S3LoadBalancerController API

GET
/s3-load-balancers/
List s3 load balancers
ListS3LoadBalancers 5 params → 200500
GET
/s3-load-balancers/samples
Get samples of multiple s3 load balancers
BatchGetS3LoadBalancerSamples → 200400404500
GET
/s3-load-balancers/{load_balancer_id}
Get s3 load balancer
GetS3LoadBalancer 1 param → 200400404500
GET
/s3-load-balancers/{s3_load_balancer_id}/samples
get a s3 load balancer's samples
GetS3LoadBalancerSamples 4 params → 200400404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are S3LoadBalancer (21 properties), Paging (10 properties), S3LoadBalancerStat (8 properties), S3LoadBalancerSamplesElem (3 properties). Each schema is shown below with its type and property counts.

S3LoadBalancerResp
object
1 property 1 required
S3LoadBalancerGroup_Nestview
object
3 properties
SSLCertificate_Nestview
object
3 properties
S3LoadBalancerSamplesElem
object
3 properties
S3LoadBalancerStat
object
S3LoadBalancerStat define s3 load balancer stat info
8 properties
S3LoadBalancersResp
object
1 property 1 required
Host_Nestview
object
3 properties 1 required
S3LoadBalancerSamplesResp
object
1 property 1 required
Paging
object
Paging defines paging object
10 properties
S3LoadBalancer
object
S3LoadBalancer is a load balancer for rados loadBalancers @grpc-models-proto
21 properties
S3LoadBalancerRecord
S3LoadBalancerRecord defines s3 load balancer with samples
MultiS3LoadBalancersSamplesResp
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-s3-load-balancers-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

XSKY access-paths API
XSKY access-tokens API
XSKY action-logs API
XSKY alert-groups API
XSKY alert-rules API
XSKY alerts API
XSKY auth API
XSKY block-snapshots API
XSKY block-volume-group-snapshots API
XSKY block-volume-groups API
XSKY block-volume-migration-jobs API
XSKY block-volumes API