XSKY os-buckets API
ObjectStorageBucketController provides API for object storage bucket
XSKY os-buckets API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include os-buckets. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 32 operations across 25 paths, and defines 68 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.
32 operations
25 paths
68 schemas
3 DELETE6 GET2 PATCH20 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
XSKY os-buckets 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 tokentokenInQuery— auth by token
Paths & Operations 32
Across 25 paths, the API surfaces 32 operations — 3 DELETE, 6 GET, 2 PATCH, 20 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
os-buckets 32
ObjectStorageBucketController provides API for object storage bucket
GET
/os-buckets/
List object storage buckets
POST
/os-buckets/
Create os bucket
GET
/os-buckets/samples
Get samples of multiple object storage buckets
GET
/os-buckets/{bucket_id}
Get object storage bucket
DELETE
/os-buckets/{bucket_id}
delete object storage bucket
PATCH
/os-buckets/{bucket_id}
Update object storage bucket
PUT
/os-buckets/{bucket_id}/lifecycle
Set object storage lifecycle rules
DELETE
/os-buckets/{bucket_id}/lifecycle
delete object storage lifecycle
GET
/os-buckets/{bucket_id}/nfs-clients
List nfs clients
POST
/os-buckets/{bucket_id}/nfs-clients
create nfs client
DELETE
/os-buckets/{bucket_id}/nfs-clients
delete nfs clients
GET
/os-buckets/{bucket_id}/nfs-clients/{client_id}
show nfs client
PATCH
/os-buckets/{bucket_id}/nfs-clients/{client_id}
update nfs client
GET
/os-buckets/{bucket_id}/samples
get an object storage bucket's Samples
POST
/os-buckets/{bucket_id}:add-custom-labels
add object storage bucket custom labels
POST
/os-buckets/{bucket_id}:add-os-replication-paths
add os replication paths for os bucket
POST
/os-buckets/{bucket_id}:add-os-replication-zones
add os replication zones for os bucket
POST
/os-buckets/{bucket_id}:remove-custom-labels
remove object storage bucket custom labels
POST
/os-buckets/{bucket_id}:remove-os-bucket-loggings
Remove os bucket loggings of os bucket
POST
/os-buckets/{bucket_id}:remove-os-replication-paths
remove os replication paths for os bucket
POST
/os-buckets/{bucket_id}:remove-os-replication-zones
remove os replication zones for os bucket
POST
/os-buckets/{bucket_id}:set-access-logging
Set access logging of os bucket
POST
/os-buckets/{bucket_id}:set-bucket-policy
set object storage bucket policy
POST
/os-buckets/{bucket_id}:set-metadata-search
set object storage bucket metadata search
POST
/os-buckets/{bucket_id}:suspend-access-logging
suspend access logging for os bucket
POST
/os-buckets/{bucket_id}:suspend-os-replication-paths
suspend os replication paths for os bucket
POST
/os-buckets/{bucket_id}:switch-owner-os-zone
Switch owner zone of os bucket
POST
/os-buckets/{bucket_id}:unset-access-logging
Unset access logging of os bucket
POST
/os-buckets/{bucket_id}:unset-bucket-policy
unset object storage bucket policy
POST
/os-buckets/{bucket_id}:unsuspend-access-logging
unsuspend access logging for os bucket
POST
/os-buckets/{bucket_id}:unsuspend-os-replication-paths
unsuspend os replication paths for os bucket
POST
/os-buckets/{bucket_id}:update-custom-labels
update object storage bucket custom labels
Schemas 68
The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are ObjectStorageBucket (35 properties), ObjectStorageBucketCreateReq_Bucket (10 properties), Paging (10 properties), ObjectStorageBucketUpdateReq_Bucket (8 properties). Each schema is shown below with its type and property counts.
OSBucketPolicySetReq_Bucket
object
1 property
1 required
ObjectStorageBucket_Nestview_lifecycle
object
3 properties
ObjectStorageBucketCreateReq_Bucket
object
10 properties
3 required
ObjectStorageBucketsResp
object
1 property
1 required
OSBucketUpdateReplicationPathsReq
object
1 property
1 required
ObjectStorageBucket
object
ObjectStorageBucket is the model of objectstoragebucket
35 properties
LifecycleTransition
object
LifecycleTransition is the details of transition of LifecycleRule
2 properties
2 required
Paging
object
Paging defines paging object
10 properties
OSReplicationZoneReq
object
1 property
1 required
OSBucketCustomLabelsAddReq_Bucket
object
1 property
1 required
OSBucketMetadataSearchSetReq
object
1 property
1 required
OSBucketRemoveReplicationPathsReq_Bucket
object
1 property
1 required
OSBucketAddReplicationZonesReq
object
1 property
1 required
OSBucketCustomLabelsAddReq
object
1 property
1 required
RawObjectStorageBucketResp
object
1 property
1 required
OSBucketUpdateReplicationPathsReq_Bucket
object
1 property
1 required
OSReplicationPathReq
object
1 property
1 required
OSBucketUsageCategory
object
OSBucketUsageCategory contain usage info
3 properties
ObjectStorageBucketStat
ObjectStorageBucketStat define the object storage bucket statistics
ObjectStorageBucketUpdateReq
object
1 property
OSBucketAddReplicationPathsReq_Bucket
object
2 properties
ObjectStorageBucketSamplesResp
object
1 property
1 required
ObjectStorageBucketUpdateReq_Bucket
object
8 properties
OSBucketSetAccessLoggingReq_Bucket
object
4 properties
ObjectStorageBucketSamplesElem
object
3 properties
OSBucketSwitchOwnerOSZoneReq_Bucket
object
1 property
OSBucketAddReplicationPathsReq
object
1 property
1 required
ObjectStoragePolicy_Nestview
object
2 properties
ObjectStorageLifecycle
object
ObjectStorageLifecycle is the model of objectstoragelifecycle
3 properties
RemoteCluster_Nestview
object
4 properties
ObjectStorageBucketRecord
ObjectStorageBucketRecord is used to combine ObjectStorageBucket and ObjectStorageBucketStat
ObjectStorageBucketNFSClientResp
object
1 property
1 required
OSBucketLoggingGrant
object
OSBucketLoggingGrant defines logging permissions of os bucket
4 properties
OSBucketCustomLabelsAddReq_Bucket_Labels_Elt
object
3 properties
3 required
OSBucketAddReplicationZonesReq_Bucket
object
2 properties
OSBucketRemoveLoggingsReq_Bucket
object
1 property
1 required
ObjectStorageBucketNFSClientUpdateReq_Client
object
1 property
ObjectStorageBucketNFSClient
object
ObjectStorageBucketNFSClient defines nfs client
7 properties
LifecycleRule
object
LifecycleRule is the details of object storage lifecycle rule
5 properties
BucketFlag
object
BucketFlag is the struct of bucket flag
3 properties
ObjectStorageZone_Nestview
object
2 properties
ObjectStorageBucketNFSClientsCreateReq
object
1 property
1 required
ObjectStorageBucketResp
object
1 property
1 required
ObjectStorageLifecycleSetReq
object
1 property
BucketFlagReq
object
3 properties
OSBucketRemoveReplicationPathsReq
object
1 property
1 required
OSBucketCustomLabelsUpdateReq
object
1 property
1 required
ObjectStorageBucketNFSClientUpdateReq
object
1 property
1 required
OSBucketRemoveReplicationZonesReq
object
1 property
1 required
OSBucketRemoveReplicationZonesReq_Bucket
object
1 property
1 required
OSBucketCustomLabelsUpdateReq_Bucket_Labels_Elt
object
2 properties
2 required
ObjectStorageBucket_Nestview
object
3 properties
OSBucketCustomLabelsUpdateReq_Bucket
object
1 property
1 required
OSSample
object
OSSample contains os samples
7 properties
OSBucketSwitchOwnerOSZoneReq
object
1 property
1 required
ObjectStorageBucketNFSClientsResp
object
1 property
1 required
LifecycleExpiration
object
LifecycleExpiration is the details of expiration of LifecycleRule
OSBucketMetadataSearchSetReq_Bucket
object
1 property
1 required
OSBucketRemoveLoggingsReq
object
1 property
1 required
MultiObjectStorageBucketsSamplesResp
object
1 property
OSBucketCustomLabelsRemoveReq_Bucket
object
1 property
1 required
ObjectStorageBucketNFSClientsCreateReq_Clients_Elt
object
2 properties
2 required
ObjectStorageBucketCreateReq
object
1 property
ObjectStorageBucketNFSClientsDeleteReq
object
1 property
1 required
OSBucketCustomLabelsRemoveReq
object
1 property
1 required
ObjectStorageUser_Nestview
object
2 properties
OSBucketPolicySetReq
object
1 property
OSBucketSetAccessLoggingReq
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from XSKY 12
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-volume-migration-jobs API
XSKY block-volumes API
#os-buckets