Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/xsky-osds-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: XMS is the controller of distributed storage system
version: SDS_4.2.000.0.200302
title: XMS access-paths Osds API
contact: {}
license:
name: Commercial
servers:
- url: /v1
tags:
- name: osds
description: 'OsdController Osd Management
'
paths:
/osds/:
get:
tags:
- osds
description: List all osds in the cluster
operationId: ListOsds
parameters:
- name: limit
in: query
description: paging param
required: false
x-exportParamName: Limit
schema:
type: integer
format: int64
- name: offset
in: query
description: paging param
required: false
x-exportParamName: Offset
schema:
type: integer
format: int64
- name: host_id
in: query
description: host id
required: false
x-exportParamName: HostId
schema:
type: integer
format: int64
- name: pool_id
in: query
description: pool id
required: false
x-exportParamName: PoolId
schema:
type: integer
format: int64
- name: osd_group_id
in: query
description: osd group id
required: false
x-exportParamName: OsdGroupId
schema:
type: integer
format: int64
- name: type
in: query
description: 'osd type: HDD, SSD, Hybrid'
required: false
x-exportParamName: Type_
schema:
type: string
- name: role
in: query
description: 'osd role: index or data'
required: false
x-exportParamName: Role
schema:
type: string
- name: with_compound
in: query
description: with compound osd
required: false
x-exportParamName: WithCompound
schema:
type: boolean
- name: with_hybrid
in: query
description: with hybrid osd
required: false
x-exportParamName: WithHybrid
schema:
type: boolean
- name: cache_disk_id
in: query
description: cache disk id
required: false
x-exportParamName: CacheDiskId
schema:
type: integer
format: int64
- name: q
in: query
description: query param of search
required: false
x-exportParamName: Q
schema:
type: string
- name: sort
in: query
description: sort param of search
required: false
x-exportParamName: Sort
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OsdsResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
post:
tags:
- osds
description: Create osd service on specific disk
operationId: CreateOsd
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OsdCreateReq'
description: osd info
required: true
/osds/{osd_id}:
get:
tags:
- osds
description: get an osd
operationId: GetOsd
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
delete:
tags:
- osds
description: remove an osd from cluster
operationId: DeleteOsd
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- osds
description: update osd info
operationId: UpdateOsd
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OsdUpdateReq'
description: osd info
required: true
/osds/{osd_id}/chunks:
get:
tags:
- osds
description: get chunks of and osd
operationId: GetChunks
parameters:
- name: osd_id
in: path
description: The id of the osd
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChunksResp'
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/osds/{osd_id}/predictions:
get:
tags:
- osds
description: get a osd's prediction
operationId: GetOsdPredictions
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OsdPredictionsResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/osds/{osd_id}/samples:
get:
tags:
- osds
description: get a osd's samples
operationId: GetOsdSamples
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
- name: duration_begin
in: query
description: duration begin timestamp
required: false
x-exportParamName: DurationBegin
schema:
type: string
- name: duration_end
in: query
description: duration end timestamp
required: false
x-exportParamName: DurationEnd
schema:
type: string
- name: period
in: query
description: samples period
required: false
x-exportParamName: Period
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OsdSamplesResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/osds/{osd_id}:maintain:
post:
tags:
- osds
description: Put osd in maintained status
operationId: MaintainOsd
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/osds/{osd_id}:rebuild:
post:
tags:
- osds
description: rebuild an osd from cluster pool
operationId: RebuildOsd
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OsdRebuildReq'
description: osd info
required: true
/osds/{osd_id}:switch-role:
post:
tags:
- osds
description: Switch osd role to compound
operationId: SwitchOsdRole
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/osds/{osd_id}:unmaintain:
post:
tags:
- osds
description: Put osd out of maintained status
operationId: UnmaintainOsd
parameters:
- name: osd_id
in: path
description: osd id
required: true
x-exportParamName: OsdId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/OsdResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
components:
schemas:
PredictionPoint:
type: object
properties:
create:
type: string
format: date-time
used_kbyte:
type: integer
format: int64
title: PredictionPoint
description: PredictionPoint is a point in a prediction graph
example:
used_kbyte: 5
create: '2000-01-23T04:56:07.000+00:00'
OsdUpdateReq:
type: object
properties:
osd:
$ref: '#/components/schemas/OsdUpdateReq_Osd'
title: OsdUpdateReq
example:
osd:
action_status: action_status
status: status
OsdCreateReq:
type: object
properties:
osd:
$ref: '#/components/schemas/OsdCreateReq_Osd'
title: OsdCreateReq
example:
osd:
partition_id: 1
role: role
omap_byte: 6
read_cache_size: 5
disk_id: 0
PartitionStat:
type: object
properties:
avg_queue_len:
type: number
format: double
create:
type: string
format: date-time
io_util:
type: number
format: double
kbyte_per_io:
type: number
format: double
read_bandwidth_kbyte:
type: number
format: double
read_iops:
type: number
format: double
read_merged_ps:
type: number
format: double
read_wait_us:
type: number
format: double
total_bandwidth_kbyte:
type: number
format: double
total_io_wait_us:
type: number
format: double
total_iops:
type: number
format: double
write_bandwidth_kbyte:
type: number
format: double
write_iops:
type: number
format: double
write_merged_ps:
type: number
format: double
write_wait_us:
type: number
format: double
title: PartitionStat
description: PartitionStat defines the basic info of a PartitionStat
OsdUpdateReq_Osd:
type: object
properties:
action_status:
type: string
status:
type: string
title: OsdUpdateReq_Osd
example:
action_status: action_status
status: status
Pool_Nestview:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
title: Pool_Nestview
example:
name: name
id: 5
DiskStat:
type: object
properties:
avg_queue_len:
type: number
format: double
create:
type: string
format: date-time
degraded_percent:
type: number
format: double
healthy_percent:
type: number
format: double
io_util:
type: number
format: double
kbyte_per_io:
type: number
format: double
omap_total_kbyte:
type: number
format: double
omap_used_kbyte:
type: number
format: double
omap_used_percent:
type: number
format: double
read_bandwidth_kbyte:
type: number
format: double
read_iops:
type: number
format: double
read_merged_ps:
type: number
format: double
read_wait_us:
type: number
format: double
recovery_percent:
type: number
format: double
total_bandwidth_kbyte:
type: number
format: double
total_io_wait_us:
type: number
format: double
total_iops:
type: number
format: double
total_kbyte:
type: integer
format: int64
unavailable_percent:
type: number
format: double
used_kbyte:
type: integer
format: int64
used_percent:
type: number
format: double
write_bandwidth_kbyte:
type: number
format: double
write_iops:
type: number
format: double
write_merged_ps:
type: number
format: double
write_wait_us:
type: number
format: double
title: DiskStat
description: DiskStat defines the basic info of a DiskStat
example:
healthy_percent: 1.4658129805029452
read_wait_us: 7.386281948385884
recovery_percent: 1.2315135367772556
total_bandwidth_kbyte: 1.0246457001441578
read_merged_ps: 4.145608029883936
read_bandwidth_kbyte: 3.616076749251911
omap_total_kbyte: 2.3021358869347655
avg_queue_len: 0.8008281904610115
create: '2000-01-23T04:56:07.000+00:00'
write_iops: 9.369310271410669
total_kbyte: 7
degraded_percent: 6.027456183070403
total_iops: 6.84685269835264
write_merged_ps: 6.683562403749608
unavailable_percent: 1.1730742509559433
read_iops: 2.027123023002322
io_util: 5.962133916683182
omap_used_kbyte: 7.061401241503109
omap_used_percent: 9.301444243932576
used_kbyte: 4
write_bandwidth_kbyte: 9.965781217890562
write_wait_us: 8.762042012749001
used_percent: 5.025004791520295
kbyte_per_io: 5.637376656633329
total_io_wait_us: 1.4894159098541704
OsdRecord:
title: OsdRecord
allOf:
- $ref: '#/components/schemas/Osd'
- properties:
samples:
type: array
items:
$ref: '#/components/schemas/OsdStat'
description: OsdRecord contains information of a osd
OsdsResp:
type: object
required:
- osds
properties:
osds:
type: array
description: osds
items:
$ref: '#/components/schemas/OsdRecord'
title: OsdsResp
example:
osds:
- ''
- ''
OsdGroup_Nestview:
type: object
properties:
id:
type: integer
format: int64
title: OsdGroup_Nestview
DiskPrediction:
type: object
properties:
create:
type: string
format: date-time
id:
type: integer
format: int64
used_kbyte_1day:
type: integer
format: int64
used_kbyte_30days:
type: integer
format: int64
used_kbyte_7days:
type: integer
format: int64
used_kbyte_points:
type: array
items:
$ref: '#/components/schemas/PredictionPoint'
title: DiskPrediction
description: DiskPrediction contains disk prediction data
example:
used_kbyte_30days: 1
used_kbyte_7days: 5
used_kbyte_points:
- used_kbyte: 5
create: '2000-01-23T04:56:07.000+00:00'
- used_kbyte: 5
create: '2000-01-23T04:56:07.000+00:00'
used_kbyte_1day: 6
create: '2000-01-23T04:56:07.000+00:00'
id: 0
OsdCreateReq_Osd:
type: object
properties:
disk_id:
type: integer
format: int64
description: data disk id
omap_byte:
type: integer
format: int64
description: size of omap partition
partition_id:
type: integer
format: int64
description: cache partition id
read_cache_size:
type: integer
format: int64
description: read cache size in bytes
role:
type: string
description: 'osd role: "data" or "index", default is "data"'
title: OsdCreateReq_Osd
example:
partition_id: 1
role: role
omap_byte: 6
read_cache_size: 5
disk_id: 0
Osd:
type: object
properties:
action_status:
type: string
create:
type: string
format: date-time
data_dir:
type: string
disk:
$ref: '#/components/schemas/Disk_Nestview'
host:
$ref: '#/components/schemas/Host_Nestview'
id:
type: integer
format: int64
in:
type: boolean
init_time:
type: string
format: date-time
last_scrub_time:
type: string
format: date-time
meta_bytes:
type: integer
format: int64
name:
type: string
omap_byte:
type: integer
format: int64
osd_group:
$ref: '#/components/schemas/OsdGroup_Nestview'
osd_id:
type: integer
format: int64
partition:
$ref: '#/components/schemas/Partition'
pool:
$ref: '#/components/schemas/Pool_Nestview'
read_cache_size:
type: integer
format: int64
role:
type: string
status:
type: string
type:
type: string
up:
type: boolean
update:
type: string
format: date-time
uuid:
type: string
title: Osd
description: Osd defines the Ceph Osd @grpc-models-proto
OsdStat:
title: OsdStat
allOf:
- $ref: '#/components/schemas/DiskStat'
- properties:
create:
type: string
format: date-time
partition:
$ref: '#/components/schemas/PartitionStat'
description: OsdStat defines the basic info of a OsdStat
ChunksResp:
type: object
required:
- chunks
properties:
chunks:
type: array
description: chunks
items:
$ref: '#/components/schemas/ChunkRecord'
title: ChunksResp
example:
chunks:
- ''
- ''
OsdRebuildReq:
type: object
properties:
osd:
$ref: '#/components/schemas/OsdRebuildReq_Osd'
title: OsdRebuildReq
example:
osd:
new_omap_byte: 6
new_partition_id: 1
new_read_cache_size: 5
new_disk_id: 0
Disk_Nestview:
type: object
properties:
device:
type: string
disk_type:
type: string
id:
type: integer
format: int64
title: Disk_Nestview
example:
disk_type: disk_type
id: 0
device: device
Partition:
type: object
properties:
action_status:
type: string
create:
type: string
format: date-time
disk:
$ref: '#/components/schemas/Disk_Nestview'
id:
type: integer
format: int64
omap_byte:
type: integer
format: int64
omap_device_path:
type: string
path:
type: string
size:
type: integer
format: int64
status:
type: string
update:
type: string
format: date-time
used:
type: boolean
uuid:
type: string
version:
type: integer
format: int64
title: Partition
description: Partition defines cache partition of disk
example:
omap_device_path: omap_device_path
update: '2000-01-23T04:56:07.000+00:00'
omap_byte: 1
used: true
uuid: uuid
version: 5
path: path
disk:
disk_type: disk_type
id: 0
device: device
size: 5
create: '2000-01-23T04:56:07.000+00:00'
id: 6
action_status: action_status
status: status
PlacementGroupScrub:
type: object
properties:
id:
type: integer
format: int64
repair_status:
type: string
repair_time:
type: string
format: date-time
scrub_status:
type: string
scrub_time:
type: string
format: date-time
title: PlacementGroupScrub
description: PlacementGroupScrub defines the statistics info of placement group
OsdSamplesResp:
type: object
required:
- osd_samples
properties:
osd_samples:
type: array
description: osd samples
items:
$ref: '#/components/schemas/OsdStat'
title: OsdSamplesResp
example:
osd_samples:
- ''
- ''
OsdRebuildReq_Osd:
type: object
properties:
new_disk_id:
type: integer
format: int64
description: new data disk id
new_omap_byte:
type: integer
format: int64
description: new size of omap partition
new_partition_id:
type: integer
format: int64
description: new cache partition id
new_read_cache_size:
type: integer
format: int64
description: new read cache size in bytes
title: OsdRebuildReq_Osd
example:
new_omap_byte: 6
new_partition_id: 1
new_read_cache_size: 5
new_disk_id: 0
OsdPredictionsResp:
type: object
required:
- osd_predictions
properties:
osd_predictions:
type: array
description: osd predictions
items:
$ref: '#/components/schemas/DiskPrediction'
title: OsdPredictionsResp
example:
osd_predictions:
- used_kbyte_30days: 1
used_kbyte_7days: 5
used_kbyte_points:
- used_kbyte: 5
create: '2000-01-23T04:56:07.000+00:00'
- used_kbyte: 5
create: '2000-01-23T04:56:07.000+00:00'
used_kbyte_1day: 6
create: '2000-01-23T04:56:07.000+00:00'
id: 0
- used_kbyte_30days: 1
used_kbyte_7days: 5
used_kbyte_points:
- used_kbyte: 5
create: '2000-01-23T04:56:07.000+00:00'
- used_kbyte: 5
create: '2000-01-23T04:56:07.000+00:00'
used_kbyte_1day: 6
create: '2000-01-23T04:56:07.000+00:00'
id: 0
ChunkRecord:
title: ChunkRecord
allOf:
- $ref: '#/components/schemas/PlacementGroup'
- properties:
scrubs:
type: array
items:
$ref: '#/components/schemas/PlacementGroupScrub'
description: ChunkRecord defines chunks api response
Host_Nestview:
type: object
required:
- admin_ip
properties:
admin_ip:
type: string
id:
type: integer
format: int64
name:
type: string
title: Host_Nestview
example:
name: name
admin_ip: admin_ip
id: 0
PlacementGroup:
type: object
properties:
chunk_id:
type: string
id:
type: integer
format: int64
osd_ids:
type: array
items:
type: integer
format: int64
status:
type: string
update:
type: string
format: date-time
title: PlacementGroup
description: 'PlacementGroup defines the statistics metric of a placement group PG is not
exposed to user, rename it as chunk'
OsdResp:
type: object
required:
- osd
properties:
osd:
description: osd
$ref: '#/components/schemas/OsdRecord'
title: OsdResp
example:
osd: ''
securitySchemes:
tokenInHeader:
description: auth by token
type: apiKey
name: Xms-Auth-Token
in: header
tokenInQuery:
description: auth by token
type: apiKey
name: token
in: query