XSKY fs-arbitration-pools API
FSArbitrationPoolController File Storage Arbitration Pool Management
OpenAPI Specification
swagger: '2.0'
info:
description: XMS is the controller of distributed storage system
version: SDS_4.2.000.0.200302
title: XMS access-paths fs-arbitration-pools API
contact: {}
license:
name: Commercial
basePath: /v1
tags:
- name: fs-arbitration-pools
description: 'FSArbitrationPoolController File Storage Arbitration Pool Management
'
paths:
/fs-arbitration-pools/:
get:
tags:
- fs-arbitration-pools
description: List file storage arbitration pools
operationId: ListFSArbitrationPools
consumes:
- application/json
produces:
- application/json
parameters:
- name: limit
in: query
description: paging param
required: false
type: integer
format: int64
x-exportParamName: Limit
- name: offset
in: query
description: paging param
required: false
type: integer
format: int64
x-exportParamName: Offset
responses:
200:
description: OK
schema:
$ref: '#/definitions/FSArbitrationPoolsResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
post:
tags:
- fs-arbitration-pools
description: create file storage arbitration pool
operationId: CreateFSArbitrationPool
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: file system arbitration pool info
required: true
schema:
$ref: '#/definitions/FSArbitrationPoolCreateReq'
x-exportParamName: Body
responses:
201:
description: Created
schema:
$ref: '#/definitions/FSArbitrationPoolResp'
400:
description: BadRequest
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/fs-arbitration-pools/{fs_arbitration_pool_id}:
get:
tags:
- fs-arbitration-pools
description: Get file storage arbitration pool
operationId: GetFSArbitrationPool
consumes:
- application/json
produces:
- application/json
parameters:
- name: fs_arbitration_pool_id
in: path
description: file storage arbitration pool id
required: true
type: integer
format: int64
x-exportParamName: FsArbitrationPoolId
responses:
200:
description: OK
schema:
$ref: '#/definitions/FSArbitrationPoolResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
delete:
tags:
- fs-arbitration-pools
description: Delete file storage arbitration pool
operationId: DeleteFSArbitrationPool
consumes:
- application/json
produces:
- application/json
parameters:
- name: fs_arbitration_pool_id
in: path
description: file storage arbitration pool id
required: true
type: integer
format: int64
x-exportParamName: FsArbitrationPoolId
responses:
204:
description: Not Content
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- fs-arbitration-pools
description: Update file system arbitration pool
operationId: UpdateFSArbitrationPool
consumes:
- application/json
produces:
- application/json
parameters:
- name: fs_arbitration_pool_id
in: path
description: file system arbitration pool id
required: true
type: integer
format: int64
x-exportParamName: FsArbitrationPoolId
- in: body
name: body
description: file system arbitration pool info
required: true
schema:
$ref: '#/definitions/FSArbitrationPoolUpdateReq'
x-exportParamName: Body
responses:
202:
description: OK
schema:
$ref: '#/definitions/FSArbitrationPoolResp'
400:
description: BadRequest
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
definitions:
FSArbitrationPoolUpdateReq_Info:
type: object
required:
- pool_id
properties:
pool_id:
type: integer
format: int64
description: pool used for file system arbitration
title: FSArbitrationPoolUpdateReq_Info
FSArbitrationPoolsResp:
type: object
required:
- fs_arbitration_pools
properties:
fs_arbitration_pools:
type: array
description: file storage arbitration pools
items:
$ref: '#/definitions/FSArbitrationPool'
title: FSArbitrationPoolsResp
example:
fs_arbitration_pools:
- pool:
name: name
id: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 0
- pool:
name: name
id: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 0
FSArbitrationPoolCreateReq_Info:
type: object
required:
- pool_id
properties:
pool_id:
type: integer
format: int64
description: pool used for file system arbitration
title: FSArbitrationPoolCreateReq_Info
Pool_Nestview:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
title: Pool_Nestview
example:
name: name
id: 5
FSArbitrationPoolResp:
type: object
required:
- fs_arbitration_pool
properties:
fs_arbitration_pool:
description: file storage arbitration pool
$ref: '#/definitions/FSArbitrationPool'
title: FSArbitrationPoolResp
example:
fs_arbitration_pool:
pool:
name: name
id: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 0
FSArbitrationPoolUpdateReq:
type: object
required:
- fs_arbitration_pool
properties:
fs_arbitration_pool:
$ref: '#/definitions/FSArbitrationPoolUpdateReq_Info'
title: FSArbitrationPoolUpdateReq
FSArbitrationPoolCreateReq:
type: object
required:
- fs_arbitration_pool
properties:
fs_arbitration_pool:
$ref: '#/definitions/FSArbitrationPoolCreateReq_Info'
title: FSArbitrationPoolCreateReq
FSArbitrationPool:
type: object
properties:
create:
type: string
format: date-time
id:
type: integer
format: int64
pool:
$ref: '#/definitions/Pool_Nestview'
update:
type: string
format: date-time
title: FSArbitrationPool
description: FSArbitrationPool defines file system arbitration pool
example:
pool:
name: name
id: 5
create: '2000-01-23T04:56:07.000+00:00'
update: '2000-01-23T04:56:07.000+00:00'
id: 0
securityDefinitions:
tokenInHeader:
description: auth by token
type: apiKey
name: Xms-Auth-Token
in: header
tokenInQuery:
description: auth by token
type: apiKey
name: token
in: query