XSKY nfs-gateways API
NFSGatewayController provides API for object storage nfs gateway
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-nfs-gateways-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 Nfs Gateways API
contact: {}
license:
name: Commercial
servers:
- url: /v1
tags:
- name: nfs-gateways
description: 'NFSGatewayController provides API for object storage nfs gateway
'
paths:
/nfs-gateways/:
get:
tags:
- nfs-gateways
description: List all nfs gateways
operationId: ListNFSGateways
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: 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/NFSGatewaysResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
post:
tags:
- nfs-gateways
description: create nfs gateway
operationId: CreateNFSGateway
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayCreateReq'
description: nfs gateway info
required: true
/nfs-gateways/{gateway_id}:
get:
tags:
- nfs-gateways
description: show nfs gateway
operationId: GetNFSGateway
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
put:
tags:
- nfs-gateways
description: start/stop nfs gateway
operationId: DoNFSGateway
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
- name: force
in: query
description: force stop or no
required: false
x-exportParamName: Force
schema:
type: boolean
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayActionReq'
description: nfs gateway action info
required: true
delete:
tags:
- nfs-gateways
description: delete nfs gateway
operationId: DeleteNFSGateway
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
- name: force
in: query
description: force delete or not
required: false
x-exportParamName: Force
schema:
type: boolean
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- nfs-gateways
description: update nfs gateway
operationId: UpdateNFSGateway
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayUpdateReq'
description: nfs gateway info
required: true
/nfs-gateways/{gateway_id}/buckets:
get:
tags:
- nfs-gateways
description: List nfs gateway bucket maps
operationId: ListNFSGatewayBucketMaps
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: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayBucketMapsResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/nfs-gateways/{gateway_id}/buckets/{bucket_id}:
get:
tags:
- nfs-gateways
description: get nfs gateway bucket map
operationId: GetNFSGatewayBucketMap
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayBucketMapResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
put:
tags:
- nfs-gateways
description: add bucket to nfs gateway
operationId: CreateNFSGatewayBucketMap
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayBucketMapResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
delete:
tags:
- nfs-gateways
description: remove bucket from nfs gateway
operationId: DeleteNFSGatewayBucketMap
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: force
in: query
description: force delete or no
required: false
x-exportParamName: Force
schema:
type: boolean
responses:
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayBucketMapResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- nfs-gateways
description: update nfs gateway bucket
operationId: UpdateNFSGatewayBucketMap
parameters:
- name: gateway_id
in: path
description: nfs gateway id
required: true
x-exportParamName: GatewayId
schema:
type: integer
format: int64
- name: bucket_id
in: path
description: bucket id
required: true
x-exportParamName: BucketId
schema:
type: integer
format: int64
- name: force
in: query
description: force update bucket map
required: false
x-exportParamName: Force
schema:
type: boolean
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayBucketMapResp'
202:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayBucketMapResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NFSGatewayBucketMapUpdateReq'
description: nfs gateway bucket update info
required: true
/nfs-gateways/{gateway_id}/samples:
get:
tags:
- nfs-gateways
description: Get nfs gateway's samples
operationId: GetNFSGatewaySamples
parameters:
- name: gateway_id
in: path
description: gateway id
required: true
x-exportParamName: GatewayId
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/NFSGatewaySamplesResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
components:
schemas:
NFSGatewaysResp:
type: object
required:
- nfs_gateways
properties:
nfs_gateways:
type: array
description: nfs gateways
items:
$ref: '#/components/schemas/NFSGatewayRecord'
title: NFSGatewaysResp
example:
nfs_gateways:
- ''
- ''
NFSGatewayUpdateReq_NFSGateway:
type: object
properties:
description:
type: string
name:
type: string
title: NFSGatewayUpdateReq_NFSGateway
NFSGatewayStat:
type: object
properties:
cpu_util:
type: number
format: double
create:
type: string
format: date-time
down_bandwidth_kbyte:
type: number
format: double
down_latency_us:
type: number
format: double
down_ops:
type: number
format: double
mem_usage_percent:
type: number
format: double
up_bandwidth_kbyte:
type: number
format: double
up_latency_us:
type: number
format: double
up_ops:
type: number
format: double
title: NFSGatewayStat
description: NFSGatewayStat defines nfs gateway stat
example:
up_bandwidth_kbyte: 2.3021358869347655
up_ops: 9.301444243932576
down_bandwidth_kbyte: 6.027456183070403
down_ops: 5.962133916683182
up_latency_us: 7.061401241503109
mem_usage_percent: 5.637376656633329
create: '2000-01-23T04:56:07.000+00:00'
cpu_util: 0.8008281904610115
down_latency_us: 1.4658129805029452
NFSGatewayBucketMapUpdateReq:
type: object
required:
- nfs_gateway_bucket_map
properties:
nfs_gateway_bucket_map:
$ref: '#/components/schemas/NFSGatewayBucketMapUpdateReq_NFSGatewayBucketMap'
title: NFSGatewayBucketMapUpdateReq
NFSGatewayResp:
type: object
required:
- nfs_gateway
properties:
nfs_gateway:
description: nfs gateway
$ref: '#/components/schemas/NFSGatewayRecord'
title: NFSGatewayResp
example:
nfs_gateway: ''
NFSGateway_Nestview:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
title: NFSGateway_Nestview
example:
name: name
id: 2
NFSGatewayRecord:
title: NFSGatewayRecord
allOf:
- $ref: '#/components/schemas/NFSGateway'
- properties:
samples:
type: array
items:
$ref: '#/components/schemas/NFSGatewayStat'
description: NFSGatewayRecord combine NFSGateway and NFSGatewayStat as API response
NFSGatewayCreateReq:
type: object
required:
- nfs_gateway
properties:
nfs_gateway:
$ref: '#/components/schemas/NFSGatewayCreateReq_NFSGateway'
title: NFSGatewayCreateReq
NFSGatewayBucketMapsResp:
type: object
required:
- nfs_gateway_bucket_maps
properties:
nfs_gateway_bucket_maps:
type: array
description: maps of nfs gateway and bucket
items:
$ref: '#/components/schemas/NFSGatewayBucketMap'
title: NFSGatewayBucketMapsResp
example:
nfs_gateway_bucket_maps:
- bucket:
lifecycle:
rules:
- '{}'
- '{}'
id: 6
status: status
name: name
id: 0
mount_clients: mount_clients
mount_num: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 1
key:
id: 5
action_status: action_status
nfs_gateway:
name: name
id: 2
status: status
- bucket:
lifecycle:
rules:
- '{}'
- '{}'
id: 6
status: status
name: name
id: 0
mount_clients: mount_clients
mount_num: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 1
key:
id: 5
action_status: action_status
nfs_gateway:
name: name
id: 2
status: status
NFSGatewayCreateReq_NFSGateway:
type: object
required:
- description
- host_id
- name
- port
properties:
description:
type: string
gateway_ip:
type: string
host_id:
type: integer
format: int64
name:
type: string
port:
type: integer
format: int64
title: NFSGatewayCreateReq_NFSGateway
NFSGatewayActionReq_NFSGateway:
type: object
required:
- action
properties:
action:
type: string
title: NFSGatewayActionReq_NFSGateway
NFSGatewayBucketMapResp:
type: object
required:
- nfs_gateway_bucket_map
properties:
nfs_gateway_bucket_map:
description: map of nfs gateway and bucket
$ref: '#/components/schemas/NFSGatewayBucketMap'
title: NFSGatewayBucketMapResp
example:
nfs_gateway_bucket_map:
bucket:
lifecycle:
rules:
- '{}'
- '{}'
id: 6
status: status
name: name
id: 0
mount_clients: mount_clients
mount_num: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 1
key:
id: 5
action_status: action_status
nfs_gateway:
name: name
id: 2
status: status
ObjectStorageBucket_Nestview_lifecycle:
properties:
id:
type: integer
format: int64
rules:
type: array
items:
type: object
properties: {}
status:
type: string
example:
rules:
- '{}'
- '{}'
id: 6
status: status
ObjectStorageKey_Nestview:
type: object
properties:
id:
type: integer
format: int64
title: ObjectStorageKey_Nestview
example:
id: 5
NFSGateway:
type: object
properties:
bucket_num:
type: integer
format: int64
create:
type: string
format: date-time
description:
type: string
gateway_ip:
type: string
gateway_name:
type: string
host:
$ref: '#/components/schemas/Host_Nestview'
id:
type: integer
format: int64
mount_clients:
type: string
mount_num:
type: integer
format: int64
name:
type: string
port:
type: integer
format: int64
status:
type: string
update:
type: string
format: date-time
title: NFSGateway
description: NFSGateway defines nfs gateway @grpc-models-proto
ObjectStorageBucket_Nestview:
type: object
properties:
id:
type: integer
format: int64
lifecycle:
$ref: '#/components/schemas/ObjectStorageBucket_Nestview_lifecycle'
name:
type: string
title: ObjectStorageBucket_Nestview
example:
lifecycle:
rules:
- '{}'
- '{}'
id: 6
status: status
name: name
id: 0
NFSGatewayBucketMap:
type: object
properties:
action_status:
type: string
bucket:
$ref: '#/components/schemas/ObjectStorageBucket_Nestview'
create:
type: string
format: date-time
id:
type: integer
format: int64
key:
$ref: '#/components/schemas/ObjectStorageKey_Nestview'
mount_clients:
type: string
mount_num:
type: integer
format: int64
nfs_gateway:
$ref: '#/components/schemas/NFSGateway_Nestview'
status:
type: string
update:
type: string
format: date-time
title: NFSGatewayBucketMap
description: NFSGatewayBucketMap defines nfs gateway bucket map @grpc-models-proto
example:
bucket:
lifecycle:
rules:
- '{}'
- '{}'
id: 6
status: status
name: name
id: 0
mount_clients: mount_clients
mount_num: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 1
key:
id: 5
action_status: action_status
nfs_gateway:
name: name
id: 2
status: status
NFSGatewayBucketMapUpdateReq_NFSGatewayBucketMap:
type: object
properties:
key_id:
type: integer
format: int64
title: NFSGatewayBucketMapUpdateReq_NFSGatewayBucketMap
NFSGatewaySamplesResp:
type: object
required:
- nfs_gateway_samples
properties:
nfs_gateway_samples:
type: array
description: nfs gateway samples
items:
$ref: '#/components/schemas/NFSGatewayStat'
title: NFSGatewaySamplesResp
example:
nfs_gateway_samples:
- up_bandwidth_kbyte: 2.3021358869347655
up_ops: 9.301444243932576
down_bandwidth_kbyte: 6.027456183070403
down_ops: 5.962133916683182
up_latency_us: 7.061401241503109
mem_usage_percent: 5.637376656633329
create: '2000-01-23T04:56:07.000+00:00'
cpu_util: 0.8008281904610115
down_latency_us: 1.4658129805029452
- up_bandwidth_kbyte: 2.3021358869347655
up_ops: 9.301444243932576
down_bandwidth_kbyte: 6.027456183070403
down_ops: 5.962133916683182
up_latency_us: 7.061401241503109
mem_usage_percent: 5.637376656633329
create: '2000-01-23T04:56:07.000+00:00'
cpu_util: 0.8008281904610115
down_latency_us: 1.4658129805029452
NFSGatewayActionReq:
type: object
required:
- nfs_gateway
properties:
nfs_gateway:
$ref: '#/components/schemas/NFSGatewayActionReq_NFSGateway'
title: NFSGatewayActionReq
NFSGatewayUpdateReq:
type: object
required:
- nfs_gateway
properties:
nfs_gateway:
$ref: '#/components/schemas/NFSGatewayUpdateReq_NFSGateway'
title: NFSGatewayUpdateReq
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
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