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 block-volumes API

BlockVolumeController Operations about Block

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

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

This API exposes 18 operations across 15 paths, and defines 36 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.

18 operations 15 paths 36 schemas 1 DELETE4 GET1 PATCH12 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 block-volumes 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 18

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

block-volumes 18

BlockVolumeController Operations about Block

GET
/block-volumes/
List block volumes
ListBlockVolumes 14 params → 200400500
POST
/block-volumes/
Create block volume
CreateBlockVolume 1 param → 202400500
GET
/block-volumes/samples
Get samples of multiple block volumes
BatchGetBlockVolumeSamples → 200400404500
GET
/block-volumes/{block_volume_id}
get a block volume
GetBlockVolume 1 param → 200404500
DELETE
/block-volumes/{block_volume_id}
Delete block volume
DeleteBlockVolume 2 params → 202400404500
PATCH
/block-volumes/{block_volume_id}
Update block volume info
UpdateBlockVolume 2 params → 200400404500
GET
/block-volumes/{block_volume_id}/samples
get a block volume's Samples
GetBlockVolumeSamples 4 params → 200400404500
POST
/block-volumes/{block_volume_id}:migrate
MigrateBlockVolume 2 params → 202400404409500
POST
/block-volumes/{block_volume_id}:rebuild-replication
Rebuild block volume replication
RebuildBlockVolumeReplication 2 params → 202400404409500
POST
/block-volumes/{block_volume_id}:set-backup-protection
Set backup protection for a block volume
SetBackupProtection 2 params → 202400404500
POST
/block-volumes/{block_volume_id}:set-crc
Set block volume crc
SetBlockVolumeCrc 2 params → 200202400404500
POST
/block-volumes/{block_volume_id}:set-replication
Set block volume replication
SetBlockVolumeReplication 2 params → 202400404409500
POST
/block-volumes/{block_volume_id}:set-snapshot-protection
Set snapshot protection for a block volume
SetSnapshotProtection 2 params → 202400404500
POST
/block-volumes/{block_volume_id}:suspend-replication
Suspend block volume replication
SuspendBlockVolumeReplication 1 param → 202400404409500
POST
/block-volumes/{block_volume_id}:unset-backup-protection
Unset backup protection for a block volume
UnsetBackupProtection 2 params → 202400404500
POST
/block-volumes/{block_volume_id}:unset-crc
Unset block volume crc
UnsetBlockVolumeCrc 2 params → 200202400404500
POST
/block-volumes/{block_volume_id}:unset-replication
Unset block volume replication
SetBlockVolumeReplication 1 param → 202400404409500
POST
/block-volumes/{block_volume_id}:unset-snapshot-protection
Unset snapshot protection for a block volume
UnsetSnapshotProtection 2 params → 202400404500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Volume (54 properties), VolumeCreateReq_Volume (24 properties), VolumeStat (16 properties), Paging (10 properties). Each schema is shown below with its type and property counts.

VolumeRecord
VolumeRecord defines the response content of volume related API
DpBlockReplicationPolicy_Nestview
object
2 properties
TrashResource_Nestview
object
5 properties
VolumeReplicationSetReq
object
1 property
VolumeCreateReq
object
1 property 1 required
VolumeFailedTask
object
4 properties
Paging
object
Paging defines paging object
10 properties
VolumeUpdateReq
object
1 property 1 required
VolumeMigrateReq
object
1 property
Snapshot_Nestview
object
2 properties
VolumeSamplesResp
object
1 property 1 required
AccessPath_Nestview
object
2 properties
VolumeBackupProtectionReq
object
1 property
VolumeResp
object
1 property 1 required
VolumeSnapshotProtectionReq_Volume
object
3 properties 1 required
VolumesResp
object
1 property 1 required
VolumeCrcSetReq
object
1 property
VolumeGroup_Nestview
object
2 properties
VolumeIOSize
object
6 properties
CloudPlatform_Nestview
object
3 properties
Volume
object
Volume is the corresponding rbd image @grpc-models-proto
54 properties
RemoteCluster_Nestview
object
4 properties
VolumeUpdateReq_Volume
object
9 properties
VolumeReplicationSetReq_Volume
object
3 properties 3 required
VolumeSnapshotProtectionReq
object
1 property
VolumeMigrateReq_Volume
object
2 properties 1 required
VolumeBackupProtectionReq_Volume
object
1 property 1 required
VolumeCrcSetReq_Volume
object
1 property 1 required
VolumeNonIOTask
object
5 properties
DpBlockSnapshotPolicy_Nestview
object
2 properties
MultiVolumesSamplesResp
object
1 property
VolumeCreateReq_Volume
object
24 properties 2 required
VolumeQosSpec
object
VolumeQosSpec is a collection of all qos field
4 properties
Pool_Nestview
object
2 properties
VolumeSamplesElem
object
3 properties
VolumeStat
object
VolumeStat records volume stat info
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-block-volumes-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 chunks API