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

OsdController Osd Management

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

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

This API exposes 12 operations across 9 paths, and defines 26 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.

12 operations 9 paths 26 schemas 1 DELETE5 GET1 PATCH5 POST

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 osds 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 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 5 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

osds 12

OsdController Osd Management

GET
/osds/
List all osds in the cluster
ListOsds 12 params → 200400500
POST
/osds/
Create osd service on specific disk
CreateOsd 1 param → 202400404500
GET
/osds/{osd_id}
get an osd
GetOsd 1 param → 200404500
DELETE
/osds/{osd_id}
remove an osd from cluster
DeleteOsd 1 param → 202400404409500
PATCH
/osds/{osd_id}
update osd info
UpdateOsd 2 params → 202400404500
GET
/osds/{osd_id}/chunks
get chunks of and osd
GetChunks 1 param → 200404409500
GET
/osds/{osd_id}/predictions
get a osd's prediction
GetOsdPredictions 1 param → 200404500
GET
/osds/{osd_id}/samples
get a osd's samples
GetOsdSamples 4 params → 200400404500
POST
/osds/{osd_id}:maintain
Put osd in maintained status
MaintainOsd 1 param → 202400404500
POST
/osds/{osd_id}:rebuild
rebuild an osd from cluster pool
RebuildOsd 2 params → 202400404409500
POST
/osds/{osd_id}:switch-role
Switch osd role to compound
SwitchOsdRole 1 param → 200202400404409500
POST
/osds/{osd_id}:unmaintain
Put osd out of maintained status
UnmaintainOsd 1 param → 202400404500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are DiskStat (25 properties), Osd (23 properties), PartitionStat (15 properties), Partition (13 properties). Each schema is shown below with its type and property counts.

DiskPrediction
object
DiskPrediction contains disk prediction data
6 properties
PartitionStat
object
PartitionStat defines the basic info of a PartitionStat
15 properties
Disk_Nestview
object
3 properties
ChunkRecord
ChunkRecord defines chunks api response
Osd
object
Osd defines the Ceph Osd @grpc-models-proto
23 properties
OsdStat
OsdStat defines the basic info of a OsdStat
PredictionPoint
object
PredictionPoint is a point in a prediction graph
2 properties
PlacementGroup
object
PlacementGroup defines the statistics metric of a placement group PG is not exposed to user, rename it as chunk
5 properties
OsdRecord
OsdRecord contains information of a osd
PlacementGroupScrub
object
PlacementGroupScrub defines the statistics info of placement group
5 properties
OsdCreateReq_Osd
object
5 properties
Host_Nestview
object
3 properties 1 required
OsdRebuildReq
object
1 property
OsdCreateReq
object
1 property
OsdUpdateReq
object
1 property
DiskStat
object
DiskStat defines the basic info of a DiskStat
25 properties
ChunksResp
object
1 property 1 required
OsdPredictionsResp
object
1 property 1 required
Partition
object
Partition defines cache partition of disk
13 properties
OsdRebuildReq_Osd
object
4 properties
OsdUpdateReq_Osd
object
2 properties
OsdsResp
object
1 property 1 required
Pool_Nestview
object
2 properties
OsdGroup_Nestview
object
1 property
OsdSamplesResp
object
1 property 1 required
OsdResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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