Supported APIs
This section focuses on the compatibility of parallel file systems and existing OBS APIs, and provides a differential description of APIs that are partly compatible.
For details about the OBS APIs, see OBS API Reference.
API Operations on Buckets
| API | PFS Compatible | Differences |
|---|---|---|
| Listing buckets | Yes | The x-obs-bucket-type:POSIX header field is required for obtaining the list of parallel file systems. |
| Creating a bucket | Yes | The x-obs-fs-file-interface:Enabled header field is required for creating a parallel file system. |
| Listing objects in a bucket | Yes | - |
| Obtaining bucket metadata | Yes | - |
| Obtaining bucket region locations | Yes | - |
| Deleting a bucket | Yes | - |
API Operations on Advanced Bucket Settings
| API | PFS Compatible | Differences |
|---|---|---|
| Configuring a bucket policy | Yes | - |
| Obtaining bucket policy information | Yes | - |
| Deleting a bucket policy | Yes | - |
| Configuring a bucket ACL | Yes | - |
| Obtaining bucket ACL information | Yes | - |
| Configuring logging for a bucket | Yes | - |
| Obtaining a bucket logging configuration | Yes | - |
| Configuring bucket lifecycle rules | Yes | - |
| Obtaining bucket lifecycle configuration | Yes | - |
| Deleting bucket lifecycle rules | Yes | - |
| Configuring versioning for a bucket | No | - |
| Obtaining bucket versioning status | No | - |
| Configuring event notification for a bucket | Yes | - |
| Obtaining the event notification configuration of a bucket | Yes | - |
| Configuring storage class for a bucket | No | - |
| Obtaining bucket storage class information | No | - |
| Configuring cross-region replication for a bucket | No | - |
| Obtaining the cross-region replication configuration of a bucket | No | - |
| Deleting the cross-region replication configuration of a bucket | No | - |
| Configuring tags for a bucket | Yes | - |
| Obtaining bucket tags | Yes | - |
| Deleting bucket tags | Yes | - |
| Configuring bucket storage quota | Yes | - |
| Querying bucket storage quota | Yes | - |
| Querying information about used space in a bucket | Yes | - |
| Configuring bucket inventories | No | - |
| Obtaining bucket inventories | No | - |
| Listing bucket inventories | No | - |
| Deleting bucket inventories | No | - |
| Configuring a custom domain name for a bucket | Yes | - |
| Obtaining the custom domain name of a bucket | Yes | - |
| Deleting a custom domain name of a bucket | Yes | - |
| Configuring bucket encryption | No | - |
| Obtaining bucket encryption configuration | No | - |
| Deleting the encryption configuration of a bucket | No | - |
| Setting the direct reading policy for Archive objects in a bucket | Yes | - |
| Obtaining the direct reading policy for Archive objects in a bucket | Yes | - |
| Deleting the direct reading policy for Archive objects in a bucket | Yes | - |
API Operations for Static Website Hosting
| API | PFS Compatible | Differences |
|---|---|---|
| Configuring static website hosting for a bucket | No | - |
| Obtaining the static website hosting configuration of a bucket | No | - |
| Deleting the static website hosting configuration of a bucket | No | - |
| Configuring bucket CORS | No | - |
| Obtaining the CORS configuration of a bucket | No | - |
| Deleting the CORS configuration of a bucket | No | - |
| OPTIONS buckets | No | - |
| OPTIONS objects | No | - |
API Operations on Objects
| API | PFS Compatible | Differences |
|---|---|---|
| PUT objects | Yes | The following header fields are not supported: x-obs-storage-class, x-obs-website-redirect-location, x-obs-server-side-encryption, x-obs-server-side-encryption-kms-key-id, x-obs-server-side-encryption-customer-algorithm, x-obs-server-side-encryption-customer-key, x-obs-server-side-encryption-customer-key-MD5, success-action-redirect, and x-obs-expires |
| POST objects | Yes | The following header fields are not supported: x-obs-storage-class, x-obs-website-redirect-location, x-obs-server-side-encryption, x-obs-server-side-encryption-kms-key-id, x-obs-server-side-encryption-customer-algorithm, x-obs-server-side-encryption-customer-key, x-obs-server-side-encryption-customer-key-MD5, success-action-redirect, and x-obs-expires |
| Copying objects | Yes | Data can be replicated between a parallel file system and a bucket only when the parallel file system and the bucket are in the same cluster. |
| Obtaining object content | Yes | - |
| Obtaining object metadata | Yes | - |
| Deleting objects | Yes | - |
| Batch deleting objects | Yes | - |
| Restoring Archive objects | √ | - |
| Appending objects | No | - |
| Configuring object ACL | Yes | - |
| Obtaining object ACL information | Yes | - |
| Modifying object metadata | Yes | - |
| Modifying an object | Yes | This is a PFS only API, and is not supported by OBS buckets. |
| Truncating an object | Yes | This is a PFS only API, and is not supported by OBS buckets. |
| Renaming an object | Yes | This is a PFS only API, and is not supported by OBS buckets. |
API Operations for Multipart Tasks
| API | PFS Compatible | Differences |
|---|---|---|
| Listing initialized multipart tasks in a bucket | Yes | - |
| Initiating multipart upload tasks | Yes | - |
| Uploading parts | Yes | - |
| Copying parts | Yes | Copying parts is not supported for an appended file. |
| Listing uploaded parts | Yes | - |
| Merging parts | Yes | - |
| Canceling multipart tasks | Yes | - |
Last Article: Managing Parallel File Systems by APIs
Next Article: Managing Parallel File Systems by obsfs
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.