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 osd-groups API

OsdGroupController API /osd-groups

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

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

This API exposes 10 operations across 10 paths, and defines 14 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.

10 operations 10 paths 14 schemas 3 GET7 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 osd-groups 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 10

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

osd-groups 10

OsdGroupController API /osd-groups

GET
/osd-groups/
List osd groups
ListOsdGroups 4 params → 200400500
GET
/osd-groups/{group_id}
Get osd group
GetOsdGroup 1 param → 200400404500
GET
/osd-groups/{group_id}/samples
get a osd group's samples
GetOsdGroupSamples 4 params → 200400404500
POST
/osd-groups/{group_id}:add-osds
Add osds to osd grouop
AddOsdsToOsdGroup 2 params → 202400404409500
POST
/osd-groups/{group_id}:disable-device-type-check
Disable device type check when add osd
DisableDeviceTypeCheck 1 param → 200404409500
POST
/osd-groups/{group_id}:enable-device-type-check
Enable device type check when add osd
EnableDeviceTypeCheck 1 param → 200400404409500
POST
/osd-groups/{group_id}:remove-osds
Remove multiple osds from a osd group
RemoveOsdsFromOsdGroup 2 params → 202400404409500
POST
/osd-groups/{group_id}:reweight
Reweight pools of osd group
ReweightOsdGroup 1 param → 202404409500
POST
/osd-groups/{group_id}:set-osd-full-ratio
Set osd full ratio of osd group
SetOsdFullRatio 2 params → 202400404409500
POST
/osd-groups/{group_id}:set-qos
Set osd group's qos
SetOsdGroupQos 2 params → 202400404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are OsdGroup (13 properties), OsdQos (6 properties), OsdGroupStat (3 properties), Pool_Nestview (2 properties). Each schema is shown below with its type and property counts.

OsdQos
object
OsdQos defines qos for osd
6 properties
OsdGroupRecord
OsdGroupRecord combine OsdGroup and OsdGroupStat as API response
OsdGroupSetQosReq
object
1 property 1 required
OsdGroupOsdsUpdateReq_OsdGroup
object
1 property 1 required
OsdGroupStat
object
OsdGroupStat defines stat of a osd group
3 properties
SetOsdFullRatioReq_OsdGroup
object
1 property 1 required
Pool_Nestview
object
2 properties
OsdGroupSetQosReq_OsdGroup
object
1 property 1 required
OsdGroupSamplesResp
object
1 property 1 required
SetOsdFullRatioReq
object
1 property 1 required
OsdGroup
object
OsdGroup defines model of osd group
13 properties
OsdGroupsResp
object
1 property
OsdGroupResp
object
1 property
OsdGroupOsdsUpdateReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-osd-groups-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