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

DiskController Disk Management

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

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

This API exposes 6 operations across 4 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.

6 operations 4 paths 14 schemas 1 DELETE3 GET1 PATCH1 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 disks 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 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

disks 6

DiskController Disk Management

GET
/disks/
List all pyhsical disks in the system
ListDisks 7 params → 200400500
GET
/disks/{disk_id}
Get a disk
GetDisk 1 param → 200404500
PATCH
/disks/{disk_id}
update disk info
UpdateDisk 2 params → 200400404500
PUT
/disks/{disk_id}/partitions
create cache partitions for disk
CreatePartitions 3 params → 202400404500
DELETE
/disks/{disk_id}/partitions
delete cache partitions of disk
DeletePartitions 1 param → 200400404500
GET
/disks/{disk_id}/samples
get a disk's samples
GetDiskSamples 4 params → 200400404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Disk (28 properties), DiskStat (25 properties), Partition (13 properties), SmartAttr (12 properties). Each schema is shown below with its type and property counts.

DiskRecord
DiskRecord contains information of a disk
DiskSamplesResp
object
1 property 1 required
PartitionsCreateReq
object
1 property
PartitionsCreateReq_Partitions
object
2 properties
Host_Nestview
object
3 properties 1 required
DisksResp
object
1 property 1 required
DiskUpdateReq
object
1 property 1 required
DiskUpdateReq_Disk
object
3 properties
DiskResp
object
1 property 1 required
Disk
object
Disk defines the available disk @grpc-models-proto
28 properties
DiskStat
object
DiskStat defines the basic info of a DiskStat
25 properties
SmartAttr
object
SmartAttr defines disk smart attribute
12 properties
Partition
object
Partition defines cache partition of disk
13 properties
Disk_Nestview
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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