Updated on 2024-11-19 GMT+08:00

SDK Function Matrices

Table 1 describes the OBS APIs supported by Java, Python, C, .NET, Node.js, and Android SDKs.

Table 2 describes the OBS APIs supported by iOS, PHP, Go, BrowserJS, and Harmony SDKs.

Table 1 Function matrix 1 of OBS SDKs

Type

API

Function

Java

Python

C

.NET

Node.js

Android

Bucket-related APIs

Listing Buckets

listBuckets

Supported

Supported

Supported

Supported

Supported

Supported

Creating a Bucket

createBucket

Supported

Supported

Supported

Supported

Supported

Supported

Listing Objects in a Bucket

listObjects

Supported

Supported

Supported

Supported

Supported

Supported

Listing Object Versions in a Bucket

listVersions

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Metadata

getBucketMetadata

Supported

Supported

Not supported

Supported

Supported

Supported

Obtaining Bucket Location

getBucketLocation

Supported

Supported

Not supported

Supported

Supported

Supported

Deleting Buckets

deleteBucket

Supported

Supported

Supported

Supported

Supported

Supported

Configuring a Bucket Policy

setBucketPolicy

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Policy Information

getBucketPolicy

Supported

Supported

Supported

Supported

Supported

Supported

Deleting a Bucket Policy

deleteBucketPolicy

Supported

Supported

Supported

Supported

Supported

Supported

Configuring a Bucket ACL

setBucketAcl

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket ACL Information

getBucketAcl

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Logging for a Bucket

setBucketLogging, setBucketLoggingConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Logging Configuration

getBucketLogging, getBucketLoggingConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Bucket Lifecycle Rules

setBucketLifecycle, setBucketLifecycleConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Lifecycle Configuration

getBucketLifecycle, getBucketLifecycleConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Deleting Lifecycle Rules

deleteBucketLifecycle, deleteBucketLifecycleConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Versioning for a Bucket

setBucketVersioning, setBucketVersioningConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Versioning Status

getBucketVersioning, getBucketVersioningConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Storage Class for a Bucket

setBucketStoragePolicy

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Storage Class Information

getBucketStoragePolicy

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Cross-Region Replication for a Bucket

setBucketReplication

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Obtaining the Cross-Region Replication Configuration of a Bucket

getBucketReplication

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Deleting the Cross-Region Replication Configuration of a Bucket

deleteBucketReplication

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Configuring Tags for a Bucket

setBucketTagging

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Tags

getBucketTagging

Supported

Supported

Supported

Supported

Supported

Supported

Deleting Tags

deleteBucketTagging

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Bucket Storage Quota

setBucketQuota

Supported

Supported

Supported

Supported

Supported

Supported

Querying Bucket Storage Quota

getBucketQuota

Supported

Supported

Supported

Supported

Supported

Supported

Querying Information About Used Space in a Bucket

getBucketStorageInfo

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Static Website Hosting for a Bucket

setBucketWebsite, setBucketWebsiteConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining the Static Website Hosting Configuration of a Bucket

getBucketWebsite, getBucketWebsiteConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Deleting the Static Website Hosting Configuration of a Bucket

deleteBucketWebsite, deleteBucketWebsiteConfiguration

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Bucket CORS

setBucketCors

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining the CORS Configuration of a Bucket

getBucketCors

Supported

Supported

Supported

Supported

Supported

Supported

Deleting the CORS Configuration of a Bucket

deleteBucketCors

Supported

Supported

Supported

Supported

Supported

Supported

Configuring Bucket Inventories

setBucketInventory

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Obtaining Bucket Inventories

getBucketInventory

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Listing Bucket Inventories

listBucketInventory

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Deleting Bucket Inventories

deleteBucketInventory

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Configuring Direct Reading for Archive Objects in a Bucket

setDirectcoldaccess

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Obtaining the Direct Reading Policy of Archive Objects in a Bucket

getDirectcoldaccess

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Deleting the Direct Reading Policy of Archive Objects in a Bucket

deleteDirectcoldaccess

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Configuring Bucket Encryption

setBucketEncryption

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Obtaining Bucket Encryption Configuration

getBucketEncryption

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Deleting the Encryption Configuration of a Bucket

deleteBucketEncryption

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Configuring a Custom Domain Name for a Bucket

setBucketCustomedomain

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Obtaining the Custom Domain Name of a Bucket

getBucketCustomdomain

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Deleting the Custom Domain Name of a Bucket

deleteBucketCustomdomain

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Object-related APIs

Uploading Objects - PUT

putObject

Supported

Supported

Supported

Supported

Supported

Supported

Copying Objects

copyObject

Supported

Supported

Supported

Supported

Supported

Supported

Downloading Objects

getObject

Supported

Supported

Supported

Supported

Supported

Supported

Querying Object Metadata

getObjectMetadata

Supported

Supported

Supported

Supported

Supported

Supported

Deleting an Object

deleteObject

Supported

Supported

Supported

Supported

Supported

Supported

Deleting Objects

deleteObjects

Supported

Supported

Supported

Supported

Supported

Supported

Restoring Archive Objects

restoreObject

Supported

Supported

Supported

Supported

Supported

Supported

Appending an Object

appendObject

Supported

Supported

Supported

Supported

Supported

Supported

Configuring an Object ACL

setObjectAcl

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining Object ACL Configuration

getObjectAcl

Supported

Supported

Supported

Supported

Supported

Supported

Modifying Object Metadata

setObjectMetadata

Supported

Supported

Not supported

Not supported

Not supported

Supported

Listing Initiated Multipart Uploads in a Bucket

listMultipartUploads

Supported

Supported

Supported

Supported

Supported

Supported

Initiating a Multipart Upload

initiateMultipartUpload

Supported

Supported

Supported

Supported

Supported

Supported

Multipart Upload

uploadPart

Supported

Supported

Supported

Supported

Supported

Supported

Uploading a Part of an Object - Copy

copyPart

Supported

Supported

Supported

Supported

Supported

Supported

Listing Uploaded Parts of an Object

listParts

Supported

Supported

Supported

Supported

Supported

Supported

Completing a Multipart Upload

completeMultipartUpload

Supported

Supported

Supported

Supported

Supported

Supported

Canceling a Multipart Upload

abortMultipartUpload

Supported

Supported

Supported

Supported

Supported

Supported

POSIX features

Creating a POSIX-compatible Bucket

newBucket

Supported

Not supported

Supported

Not supported

Not supported

Supported

Listing POSIX-compatible Buckets

listBuckets

Supported

Not supported

Not supported

Not supported

Not supported

Supported

Modifying an Object

modifyObject

Supported

Not supported

Supported

Not supported

Not supported

Supported

Renaming an Object

renameObject

Supported

Not supported

Supported

Not supported

Not supported

Supported

Truncating a POSIX File

truncateObject

Supported

Not supported

Supported

Not supported

Not supported

Supported

Temporary authentication

Calculating the Temporarily Authorized Signature URL

createSignedUrl (Python, Go), createTemporarySignature (Java)

Supported

Supported

Supported

Supported

Supported

Supported

Calculating Authentication Parameters of a POST Form

createPostSignature, createBrowserBasedSignature

Supported

Supported

Not supported

Not supported

Supported

Supported

Supporting Authentication with a Security Token

N/A

Supported

Supported

Supported

Supported

Supported

Supported

New features

Configuring Object Lifecycle Rules in an Upload

putObject, initiateMultipartUpload

Supported

Supported

Supported

Supported

Supported

Supported

Supporting Multi-Project Management (epid)

createBucket, getBucketMetadata

Supported

Supported

Not supported

Not supported

Not supported

Supported

Configuring Image Transcoding Parameters in a Download

getObject

Supported

Supported

Supported

Supported

Supported

Supported

Obtaining the Bucket Region Information in a List Operation

listBuckets

Supported

Supported

Supported

Supported

Supported

Supported

Value-added functions

Uploading Objects - Streaming

putObject

Supported

Supported

Supported

Supported

Supported

Supported

Download Objects - Streaming

getObject

Supported

Supported

Supported

Supported

Supported

Supported

Uploading Parts - Streaming

uploadPart

Supported

Supported

Supported

Supported

Supported

Supported

Uploading a File Using a Multipart Upload (Resumable Transfer Supported)

uploadFile

Supported

Supported

Supported

Supported

Supported

Supported

Downloading a File Using a Multipart Download (Resumable Transfer Supported)

downloadFile

Supported

Supported

Supported

Supported

Supported

Supported

Automatically Configuring MIME Based on Object Name Suffix

putObject, initiateMultipartUpload

Supported

Supported

Not supported

Supported

Supported

Supported

Configuring an HTTP Proxy

N/A

Supported

Supported

Supported

Supported

Not supported

Supported

Asynchronous API

N/A

Not supported

Not supported

Not supported

Supported

Supported

Not supported

Restoring Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Downloading Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Uploading Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Copying Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Viewing the Data Transmission Progress

putObject, uploadFile, uploadPart, getObject, downloadFile

Supported

Supported

Not supported

Supported

Not supported

Supported

Configuring a Persistent or Temporary Connection

N/A

Supported

Supported

Not supported

Supported

Supported

Supported

Configuring Logs

N/A

Supported

Supported

Supported

Supported

Supported

Supported

Table 2 Function matrix 2 of OBS SDKs

Type

API

Function

iOS

PHP

Go

BrowserJS

Harmony

Bucket-related APIs

Listing Buckets

listBuckets

Supported

Supported

Supported

Not supported

Creating a Bucket

createBucket

Supported

Supported

Supported

Not supported

Listing Objects in a Bucket

listObjects

Supported

Supported

Supported

Supported

Supported

Listing Object Versions in a Bucket

listVersions

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Metadata

getBucketMetadata

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Location

getBucketLocation

Supported

Supported

Supported

Supported

Supported

Deleting Buckets

deleteBucket

Supported

Supported

Supported

Supported

Supported

Configuring a Bucket Policy

setBucketPolicy

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Policy Information

getBucketPolicy

Supported

Supported

Supported

Supported

Supported

Deleting a Bucket Policy

deleteBucketPolicy

Supported

Supported

Supported

Supported

Supported

Configuring a Bucket ACL

setBucketAcl

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket ACL Information

getBucketAcl

Supported

Supported

Supported

Supported

Supported

Configuring Logging for a Bucket

setBucketLogging, setBucketLoggingConfiguration

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Logging Configuration

getBucketLogging, getBucketLoggingConfiguration

Supported

Supported

Supported

Supported

Supported

Configuring Bucket Lifecycle Rules

setBucketLifecycle, setBucketLifecycleConfiguration

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Lifecycle Configuration

getBucketLifecycle, getBucketLifecycleConfiguration

Supported

Supported

Supported

Supported

Supported

Deleting Lifecycle Rules

deleteBucketLifecycle, deleteBucketLifecycleConfiguration

Supported

Supported

Supported

Supported

Supported

Configuring Versioning for a Bucket

setBucketVersioning, setBucketVersioningConfiguration

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Versioning Status

getBucketVersioning, getBucketVersioningConfiguration

Supported

Supported

Supported

Supported

Supported

Configuring Storage Class for a Bucket

setBucketStoragePolicy

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Storage Class Information

getBucketStoragePolicy

Supported

Supported

Supported

Supported

Supported

Configuring Cross-Region Replication for a Bucket

setBucketReplication

Not supported

Not supported

Not supported

Not supported

Not supported

Obtaining the Cross-Region Replication Configuration of a Bucket

getBucketReplication

Not supported

Not supported

Not supported

Not supported

Not supported

Deleting the Cross-Region Replication Configuration of a Bucket

deleteBucketReplication

Not supported

Not supported

Not supported

Not supported

Not supported

Configuring Tags for a Bucket

setBucketTagging

Supported

Supported

Supported

Supported

Supported

Obtaining Bucket Tags

getBucketTagging

Supported

Supported

Supported

Supported

Supported

Deleting Tags

deleteBucketTagging

Supported

Supported

Supported

Supported

Supported

Configuring Bucket Storage Quota

setBucketQuota

Supported

Supported

Supported

Supported

Supported

Querying Bucket Storage Quota

getBucketQuota

Supported

Supported

Supported

Supported

Supported

Querying Information About Used Space in a Bucket

getBucketStorageInfo

Supported

Supported

Supported

Supported

Supported

Configuring Static Website Hosting for a Bucket

setBucketWebsite, setBucketWebsiteConfiguration

Supported

Supported

Supported

Supported

Supported

Obtaining the Static Website Hosting Configuration of a Bucket

getBucketWebsite, getBucketWebsiteConfiguration

Supported

Supported

Supported

Supported

Supported

Deleting the Static Website Hosting Configuration of a Bucket

deleteBucketWebsite, deleteBucketWebsiteConfiguration

Supported

Supported

Supported

Supported

Supported

Configuring Bucket CORS

setBucketCors

Supported

Supported

Supported

Supported

Supported

Obtaining the CORS Configuration of a Bucket

getBucketCors

Supported

Supported

Supported

Supported

Supported

Deleting the CORS Configuration of a Bucket

deleteBucketCors

Supported

Supported

Supported

Supported

Supported

Configuring Bucket Inventories

setBucketInventory

Not supported

Not supported

Not supported

Not supported

×

Obtaining Bucket Inventories

getBucketInventory

Not supported

Not supported

Not supported

Not supported

×

Listing Bucket Inventories

listBucketInventory

Not supported

Not supported

Not supported

Not supported

×

Deleting Bucket Inventories

deleteBucketInventory

Not supported

Not supported

Not supported

Not supported

×

Configuring Direct Reading for Archive Objects in a Bucket

setDirectcoldaccess

Not supported

Not supported

Not supported

Not supported

×

Obtaining the Direct Reading Policy of Archive Objects in a Bucket

getDirectcoldaccess

Not supported

Not supported

Not supported

Not supported

×

Deleting the Direct Reading Policy of Archive Objects in a Bucket

deleteDirectcoldaccess

Not supported

Not supported

Not supported

Not supported

×

Configuring Bucket Encryption

setBucketEncryption

Not supported

Not supported

Supported

Not supported

Obtaining Bucket Encryption Configuration

getBucketEncryption

Not supported

Not supported

Supported

Not supported

Deleting the Encryption Configuration of a Bucket

deleteBucketEncryption

Not supported

Not supported

Supported

Not supported

Configuring a Custom Domain Name for a Bucket

setBucketCustomedomain

Not supported

Not supported

Supported

Not supported

Obtaining the Custom Domain Name of a Bucket

getBucketCustomdomain

Not supported

Not supported

Supported

Not supported

Deleting the Custom Domain Name of a Bucket

deleteBucketCustomdomain

Not supported

Not supported

Supported

Not supported

Object-related APIs

Uploading Objects - PUT

putObject

Supported

Supported

Supported

Supported

Supported

Copying Objects

copyObject

Supported

Supported

Supported

Supported

Supported

Downloading Objects

getObject

Supported

Supported

Supported

Supported

Supported

Querying Object Metadata

getObjectMetadata

Supported

Supported

Supported

Supported

Supported

Deleting an Object

deleteObject

Supported

Supported

Supported

Supported

Supported

Deleting Objects

deleteObjects

Supported

Supported

Supported

Supported

Supported

Restoring Archive Objects

restoreObject

Supported

Supported

Supported

Supported

Supported

Appending an Object

appendObject

Supported

Not supported

Supported

Supported

Supported

Configuring an Object ACL

setObjectAcl

Supported

Supported

Supported

Supported

Supported

Obtaining Object ACL Configuration

getObjectAcl

Supported

Supported

Supported

Supported

Supported

Modifying Object Metadata

setObjectMetadata

Supported

Supported

Supported

Supported

Supported

Listing Initiated Multipart Uploads in a Bucket

listMultipartUploads

Supported

Supported

Supported

Supported

Supported

Initiating a Multipart Upload

initiateMultipartUpload

Supported

Supported

Supported

Supported

Supported

Multipart Upload

uploadPart

Supported

Supported

Supported

Supported

Supported

Uploading a Part of an Object - Copy

copyPart

Supported

Supported

Supported

Supported

Supported

Listing Uploaded Parts of an Object

listParts

Supported

Supported

Supported

Supported

Supported

Completing a Multipart Upload

completeMultipartUpload

Supported

Supported

Supported

Supported

Supported

Canceling a Multipart Upload

abortMultipartUpload

Supported

Supported

Supported

Supported

Supported

POSIX features

Creating a POSIX-compatible Bucket

newBucket

Not supported

Not supported

Not supported

Not supported

Supported

Listing POSIX-compatible Buckets

listBuckets

Not supported

Not supported

Not supported

Not supported

Supported

Modifying an Object

modifyObject

Not supported

Not supported

Supported

Not supported

Supported

Renaming an Object

renameObject

Not supported

Not supported

Not supported

Not supported

Supported

Truncating a POSIX File

truncateObject

Not supported

Not supported

Not supported

Not supported

Supported

Temporary authentication

Calculating the Temporarily Authorized Signature URL

createSignedUrl (Python, Go), createTemporarySignature (Java)

Supported

Supported

Supported

Supported

Supported

Calculating Authentication Parameters of a POST Form

createPostSignature, createBrowserBasedSignature

Not supported

Supported

Not supported

Supported

Supported

Supporting Authentication with a Security Token

N/A

Supported

Supported

Supported

Supported

Supported

New features

Configuring Object Lifecycle Rules in an Upload

putObject, initiateMultipartUpload

Not supported

Not supported

Not supported

Supported

Supported

Supporting Multi-Project Management (epid)

createBucket, getBucketMetadata

Not supported

Not supported

Supported

Not supported

Supported

Configuring Image Transcoding Parameters in a Download

getObject

Not supported

Supported

Supported

Supported

Supported

Obtaining the Bucket Region Information in a List Operation

listBuckets

Supported

Supported

Supported

Supported

Supported

Value-added functions

Uploading Objects - Streaming

putObject

Supported

Supported

Supported

Supported

×

Download Objects - Streaming

getObject

Supported

Supported

Supported

Supported

×

Uploading Parts - Streaming

uploadPart

Supported

Supported

Supported

Supported

×

Uploading a File Using a Multipart Upload (Resumable Transfer Supported)

uploadFile

Supported

Not supported

Supported

Supported

×

Downloading a File Using a Multipart Download (Resumable Transfer Supported)

downloadFile

Supported

Not supported

Supported

Not supported

×

Automatically Configuring MIME Based on Object Name Suffix

putObject, initiateMultipartUpload

Not supported

Not supported

Supported

Supported

Supported

Configuring an HTTP Proxy

N/A

Supported

Not supported

Supported

Not supported

×

Asynchronous API

N/A

Supported

Supported

Not supported

Supported

Restoring Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Downloading Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Uploading Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Copying Objects

N/A

Not supported

Not supported

Not supported

Not supported

Not supported

Viewing the Data Transmission Progress

putObject, uploadFile, uploadPart, getObject, downloadFile

Supported

Not supported

Not supported

Supported

×

Configuring a Persistent or Temporary Connection

N/A

Not supported

Not supported

Not supported

Not supported

×

Configuring Logs

N/A

Supported

Supported

Supported

Supported

Supported