XSKY os-buckets API
ObjectStorageBucketController provides API for object storage bucket
ObjectStorageBucketController provides API for object storage bucket
swagger: '2.0'
info:
description: XMS is the controller of distributed storage system
version: SDS_4.2.000.0.200302
title: XMS access-paths os-buckets API
contact: {}
license:
name: Commercial
basePath: /v1
tags:
- name: os-buckets
description: 'ObjectStorageBucketController provides API for object storage bucket
'
paths:
/os-buckets/:
get:
tags:
- os-buckets
description: List object storage buckets
operationId: ListBuckets
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
- name: name
in: query
description: name of object storage buckets
required: false
type: string
x-exportParamName: Name
- name: os_policy_id
in: query
description: The id of policy object storage buckets belong to
required: false
type: integer
format: int64
x-exportParamName: OsPolicyId
- name: os_user_id
in: query
description: The id of user object storage buckets belong to
required: false
type: integer
format: int64
x-exportParamName: OsUserId
- name: replication_uuid
in: query
description: The uuid of replication os buckets belong to
required: false
type: string
x-exportParamName: ReplicationUuid
- name: virtual
in: query
description: Virtual bucket or not
required: false
type: boolean
x-exportParamName: Virtual
- name: q
in: query
description: query param of search
required: false
type: string
x-exportParamName: Q
- name: sort
in: query
description: sort param of search
required: false
type: string
x-exportParamName: Sort
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketsResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
post:
tags:
- os-buckets
description: Create os bucket
operationId: CreateBucket
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: bucket info
required: true
schema:
$ref: '#/definitions/ObjectStorageBucketCreateReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/samples:
get:
tags:
- os-buckets
description: Get samples of multiple object storage buckets
operationId: BatchGetObjectStorageSamples
consumes:
- application/json
produces:
- application/json
parameters:
- name: ids
in: query
description: bucket ids
required: true
type: string
x-exportParamName: Ids
responses:
200:
description: OK
schema:
$ref: '#/definitions/MultiObjectStorageBucketsSamplesResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:
get:
tags:
- os-buckets
description: Get object storage bucket
operationId: GetBucket
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
delete:
tags:
- os-buckets
description: delete object storage bucket
operationId: DeleteBucket
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- name: force
in: query
description: force delete or not
required: false
type: boolean
x-exportParamName: Force
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- os-buckets
description: Update object storage bucket
operationId: UpdateBucket
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: bucket info
required: true
schema:
$ref: '#/definitions/ObjectStorageBucketUpdateReq'
x-exportParamName: Body
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}/lifecycle:
put:
tags:
- os-buckets
description: Set object storage lifecycle rules
operationId: SetObjectStorageLifecycleRules
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: lifecyce rules info
required: true
schema:
$ref: '#/definitions/ObjectStorageLifecycleSetReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
delete:
tags:
- os-buckets
description: delete object storage lifecycle
operationId: DeleteObjectStorageLifecycle
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}/nfs-clients:
get:
tags:
- os-buckets
description: List nfs clients
operationId: ListObjectStorageBucketNFSClients
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
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketNFSClientsResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
post:
tags:
- os-buckets
description: create nfs client
operationId: CreateObjectStorageBucketNFSClients
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: nfs client info
required: true
schema:
$ref: '#/definitions/ObjectStorageBucketNFSClientsCreateReq'
x-exportParamName: Body
responses:
200:
description: OK
schema:
$ref: '#/definitions/RawObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/RawObjectStorageBucketResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
delete:
tags:
- os-buckets
description: delete nfs clients
operationId: DeleteObjectStorageBucketNFSClients
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: nfs client info
required: true
schema:
$ref: '#/definitions/ObjectStorageBucketNFSClientsDeleteReq'
x-exportParamName: Body
responses:
200:
description: OK
schema:
$ref: '#/definitions/RawObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/RawObjectStorageBucketResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}/nfs-clients/{client_id}:
get:
tags:
- os-buckets
description: show nfs client
operationId: GetObjectStorageBucketNFSClient
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- name: client_id
in: path
description: nfs client id
required: true
type: integer
format: int64
x-exportParamName: ClientId
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketNFSClientResp'
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
patch:
tags:
- os-buckets
description: update nfs client
operationId: UpdateObjectStorageBucketNFSClient
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- name: client_id
in: path
description: nfs client id
required: true
type: integer
format: int64
x-exportParamName: ClientId
- in: body
name: body
description: nfs client info
required: true
schema:
$ref: '#/definitions/ObjectStorageBucketNFSClientUpdateReq'
x-exportParamName: Body
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketNFSClientResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketNFSClientResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}/samples:
get:
tags:
- os-buckets
description: get an object storage bucket's Samples
operationId: GetObjectStorageBucketSamples
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- name: duration_begin
in: query
description: duration begin timestamp
required: false
type: string
x-exportParamName: DurationBegin
- name: duration_end
in: query
description: duration end timestamp
required: false
type: string
x-exportParamName: DurationEnd
- name: period
in: query
description: samples period
required: false
type: string
x-exportParamName: Period
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketSamplesResp'
400:
description: BadRequest
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:add-custom-labels:
post:
tags:
- os-buckets
description: add object storage bucket custom labels
operationId: AddCustomLabels
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: bucket custom labels info
required: true
schema:
$ref: '#/definitions/OSBucketCustomLabelsAddReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:add-os-replication-paths:
post:
tags:
- os-buckets
description: add os replication paths for os bucket
operationId: AddOSReplicationPaths
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: replication paths info
required: true
schema:
$ref: '#/definitions/OSBucketAddReplicationPathsReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:add-os-replication-zones:
post:
tags:
- os-buckets
description: add os replication zones for os bucket
operationId: AddOSReplicationZones
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: replication zones info
required: true
schema:
$ref: '#/definitions/OSBucketAddReplicationZonesReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:remove-custom-labels:
post:
tags:
- os-buckets
description: remove object storage bucket custom labels
operationId: RemoveCustomLabels
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: object storage bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: custom labels info
required: true
schema:
$ref: '#/definitions/OSBucketCustomLabelsRemoveReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:remove-os-bucket-loggings:
post:
tags:
- os-buckets
description: Remove os bucket loggings of os bucket
operationId: RemoveOSBucketLoggings
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: os bucket loggings info
required: true
schema:
$ref: '#/definitions/OSBucketRemoveLoggingsReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:remove-os-replication-paths:
post:
tags:
- os-buckets
description: remove os replication paths for os bucket
operationId: RemoveOSReplicationPaths
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: replication paths info
required: true
schema:
$ref: '#/definitions/OSBucketRemoveReplicationPathsReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:remove-os-replication-zones:
post:
tags:
- os-buckets
description: remove os replication zones for os bucket
operationId: RemoveOSReplicationZones
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- name: force
in: query
description: force delete os replication zone even if target zone is dead
required: false
type: boolean
x-exportParamName: Force
- in: body
name: body
description: replication zones info
required: true
schema:
$ref: '#/definitions/OSBucketRemoveReplicationZonesReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:set-access-logging:
post:
tags:
- os-buckets
description: Set access logging of os bucket
operationId: SetAccessLogging
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: access logging info
required: true
schema:
$ref: '#/definitions/OSBucketSetAccessLoggingReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:set-bucket-policy:
post:
tags:
- os-buckets
description: set object storage bucket policy
operationId: SetOSBucketPolicy
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: bucket policy info
required: true
schema:
$ref: '#/definitions/OSBucketPolicySetReq'
x-exportParamName: Body
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
500:
description: InternalServerError
security:
- tokenInHeader: []
- tokenInQuery: []
/os-buckets/{bucket_id}:set-metadata-search:
post:
tags:
- os-buckets
description: set object storage bucket metadata search
operationId: SetMetadataSearch
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: object storage bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: bucket metadata search info
required: true
schema:
$ref: '#/definitions/OSBucketMetadataSearchSetReq'
x-exportParamName: Body
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketsResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:suspend-access-logging:
post:
tags:
- os-buckets
description: suspend access logging for os bucket
operationId: SuspendAccessLoggings
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:suspend-os-replication-paths:
post:
tags:
- os-buckets
description: suspend os replication paths for os bucket
operationId: SuspendOSReplicationPaths
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- in: body
name: body
description: replication paths info
required: true
schema:
$ref: '#/definitions/OSBucketUpdateReplicationPathsReq'
x-exportParamName: Body
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:switch-owner-os-zone:
post:
tags:
- os-buckets
description: Switch owner zone of os bucket
operationId: SwitchOwnerOSZone
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
- name: force
in: query
description: force to switch even if old owner zone is dead
required: false
type: boolean
x-exportParamName: Force
- in: body
name: body
description: new owner os zone info
required: true
schema:
$ref: '#/definitions/OSBucketSwitchOwnerOSZoneReq'
x-exportParamName: Body
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:unset-access-logging:
post:
tags:
- os-buckets
description: Unset access logging of os bucket
operationId: UnsetAccessLogging
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:unset-bucket-policy:
post:
tags:
- os-buckets
description: unset object storage bucket policy
operationId: UnsetOSBucketPolicy
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
responses:
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
404:
description: NotFound
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:unsuspend-access-logging:
post:
tags:
- os-buckets
description: unsuspend access logging for os bucket
operationId: UnsuspendAccessLogging
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
format: int64
x-exportParamName: BucketId
responses:
200:
description: OK
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
202:
description: Accepted
schema:
$ref: '#/definitions/ObjectStorageBucketResp'
400:
description: BadRequest
404:
description: NotFound
409:
description: Conflict
500:
description: InternalServerError
security:
- tokenInQuery: []
- tokenInHeader: []
/os-buckets/{bucket_id}:unsuspend-os-replication-paths:
post:
tags:
- os-buckets
description: unsuspend os replication paths for os bucket
operationId: UnsuspendOSReplicationPaths
consumes:
- application/json
produces:
- application/json
parameters:
- name: bucket_id
in: path
description: bucket id
required: true
type: integer
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xsky/refs/heads/main/openapi/xsky-os-buckets-api-openapi.yml