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-volume-migration-jobs API

BlockVolumeMigrationJobController Operations about block volume migration job

XSKY block-volume-migration-jobs 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-volume-migration-jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

4 operations 4 paths 9 schemas 2 GET2 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-volume-migration-jobs 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 4

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

block-volume-migration-jobs 4

BlockVolumeMigrationJobController Operations about block volume migration job

GET
/block-volume-migration-jobs/
List volume migration jobs
ListBlockVolumeMigrationJobs 5 params → 200400500
GET
/block-volume-migration-jobs/{block_volume_migration_job_id}
get a volume migration job
GetBlockVolumeMigrationJob 1 param → 200404500
POST
/block-volume-migration-jobs/{block_volume_migration_job_id}:cancel
CancelBlockVolumeMigrationJob 1 param → 200202400404409500
POST
/block-volume-migration-jobs/{block_volume_migration_job_id}:update
UpdateMigration 2 params → 200202400404409500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Task (15 properties), VolumeMigrationJob (13 properties), Volume_Nestview (3 properties), Host_Nestview (3 properties). Each schema is shown below with its type and property counts.

BlockVolumeUpdateMigrationReq_VolumeMigrationJob
object
1 property 1 required
Task
object
Task defines a task will be run on a host @grpc-models-proto
15 properties
BlockVolumeUpdateMigrationReq
object
1 property
Host_Nestview
object
3 properties 1 required
Pool_Nestview
object
2 properties
VolumeMigrationJob
object
VolumeMigrationJob defines the volume migration job record
13 properties
BlockVolumeMigrationJobsResp
object
1 property 1 required
BlockVolumeMigrationJobResp
object
1 property 1 required
Volume_Nestview
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-block-volume-migration-jobs-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-volumes API
XSKY chunks API