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 cluster API

ClusterController API /cluster

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

Tagged areas include cluster. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 25 operations across 20 paths, and defines 33 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.

25 operations 20 paths 33 schemas 1 DELETE12 GET2 PATCH7 POST3 PUT

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 cluster 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 25

Across 20 paths, the API surfaces 25 operations — 1 DELETE, 12 GET, 2 PATCH, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

cluster 25

ClusterController API /cluster

GET
/cluster/
Output the status of the cluster
Cluster → 200500
PATCH
/cluster/
set disk lighting mode of cluster
UpdateCluster 1 param → 200400500
GET
/cluster/action-log-report
Get report of cluster action logs
GetActionLogReport → 200500
GET
/cluster/alert-report
Get report of cluster alerts
GetAlertReport → 200500
GET
/cluster/bootnode
get bootnode info
BootNode → 200500
PUT
/cluster/bootnode
set bootnode info
SetBootNode 1 param → 200202400500
GET
/cluster/event-log-report
Get report of cluster event logs
GetEventLogReport → 200500
GET
/cluster/installation
show the installation status
Installation → 200500
PUT
/cluster/maintenance
update maintenance mode of cluster
UpdateClusterMaintenance 1 param → 200400500
GET
/cluster/object-storage
Get object storage system status
GetObjectStorage → 200500
PUT
/cluster/object-storage
Initialize object storage system in current cluster
InitObjectStorage 1 param → 202400409500
DELETE
/cluster/object-storage
Delete object storage system in current cluster
DeleteObjectStorage 1 param → 202409500
PATCH
/cluster/object-storage
Set object storage system in current cluster
SetObjectStorage 1 param → 202400409500
POST
/cluster/object-storage:commit-master-switching
Commit the switch to new master os zone.
CommitMasterSwitching → 202400409500
POST
/cluster/object-storage:enable-multi-zone
Enable multi zone for object storage system
EnableMultiZone → 200202400409500
POST
/cluster/object-storage:prepare-master-switching
Prepare to switch to new master os zone.
PrepareMasterSwitching → 200400409500
POST
/cluster/object-storage:rollback-master-switching
Rollback the switch to new master os zone.
RollbackMasterSwitching → 200400500
POST
/cluster/object-storage:switch-os-zone-to-master
Switch current os zone to master
SwitchOSZoneToMaster 1 param → 202400409500
GET
/cluster/report
Get report of a cluster
GetClusterReport → 200500
GET
/cluster/samples
get cluster's samples
GetClusterSamples 3 params → 200500
GET
/cluster/stats
Get overview data of a cluster
GetClusterOverview → 200500
GET
/cluster/stats-usage-prediction
Get prediction of stats space usage
GetStatsUsagePrediction → 200500
GET
/cluster/time
show current server time
ServerTime → 200
POST
/cluster:remove-access-info
Remove cluster access info
RemoveClusterAccessInfo → 200400500
POST
/cluster:set-access-info
Set cluster access info
SetClusterAccessInfo 1 param → 200400500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ClusterOverview (90 properties), ClusterStat (23 properties), Cluster (16 properties), ObjectStorage (14 properties). Each schema is shown below with its type and property counts.

ObjectStorageSetReq_Info
object
5 properties
ObjectStorageInitReq_Info
object
1 property 1 required
Cluster
object
Cluster defines the ceph cluster @grpc-models-proto
16 properties
ClusterStat
object
ClusterStat defines the statistics metric of a ceph cluster
23 properties
ObjectStorageInitReq
object
1 property 1 required
ClusterOverviewResp
object
1 property 1 required
ClusterInstallation
object
ClusterInstallation returns installation status of the cluster
2 properties
ClusterSamplesResp
object
1 property 1 required
ClusterMaintainReq
object
1 property 1 required
Host_Nestview
object
3 properties 1 required
BootNodeReq
object
1 property 1 required
ObjectStorageSetReq
object
1 property 1 required
ObjectStorageResp
object
1 property
BootNodeResp
object
1 property 1 required
ClusterSetAccessInfoReq_Cluster
object
2 properties 2 required
User_Nestview
object
2 properties
ClusterSetAccessInfoReq
object
1 property 1 required
ClusterOverview
object
ClusterOverview contains overview data of a cluster
90 properties
BootNode
object
BootNode defines the status of boot node
6 properties 4 required
ClusterResp
object
1 property 1 required
ClusterInstallation_Steps
object
3 properties
ClusterRecord
ClusterRecord defines the response content of cluster related API
ClusterMaintainReq_Cluster
object
1 property 1 required
BootNodeReq_BootNode
object
4 properties 2 required
ClusterStatsPredictionResp
object
1 property
Pool_Nestview
object
2 properties
ClusterServerTimeResp
object
1 property
ClusterUpdateReq
object
1 property 1 required
ClusterInstallationResp
object
1 property
ClusterUpdateReq_Cluster
object
6 properties
ClusterRecordResp
object
1 property 1 required
AccessToken
object
AccessToken used for authentication and authorization
8 properties
ObjectStorage
object
ObjectStorage is the model of objectstorage
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-cluster-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