API overview

This topic describes the API operations provided by Object Storage Service (OSS) and their usage.

Service-related operations

API	Description
GetService (ListBuckets)	Lists all buckets owned by the requester.

Bucket-related operations

API	Description
PutBucket	Creates a bucket.
DeleteBucket	Deletes a bucket.
GetBucket(ListObject)	Lists the information about all objects in a bucket.
GetBucketInfo	Queries the information about a bucket.
GetBucketLocation	Queries the region in which a bucket is located.
PutBucketAcl	Configures the access control list (ACL) of a bucket.
GetBucketAcl	Queries the ACL of a bucket.
PutBucketLifecycle	Configures lifecycle rules for the objects in a bucket.
GetBucketLifecycle	Queries the lifecycle rules configured for the objects in a bucket.
DeleteBucketLifecycle	Deletes the lifecycle rules configured for the objects in a bucket.
PutBucketVersioning	Configures the versioning status of a bucket.
GetBucketVersioning	Queries the versioning status of a bucket.
GetBucketVersions(ListObjectVersions)	Lists the versions of all objects in a bucket.
PutBucketReplication	Configures cross-region replication (CRR) rules for a bucket.
GetBucketReplication	Queries the CRR rules configured for a bucket.
GetBucketReplicationLocation	Queries the regions in which available destination buckets are located.
GetBucketReplicationProgress	Queries the progress of a CRR task performed on a bucket.
DeleteBucketReplication	Disables CRR for a bucket and deletes the CRR rule configured for the bucket.
PutBucketPolicy	Configures policies for a bucket.
GetBucketPolicy	Queries the policies configured for a bucket.
DeleteBucketPolicy	Deletes the policies configured for a bucket.
PutBucketInventory	Configures inventory rules for a bucket.
GetBucketInventory	Queries a specified inventory task configured for a bucket.
ListBucketInventory	Queries all inventory tasks configured for a bucket.
DeleteBucketInventory	Deletes a specified inventory task configured for a bucket.
InitiateBucketWorm	Creates a retention policy.
AbortBucketWorm	Deletes an unlocked retention policy.
CompleteBucketWorm	Locks a retention policy.
ExtendBucketWorm	Extends the retention duration (days) of objects in a bucket for which a retention policy is locked.
GetBucketWorm	Queries the retention policy configured for a bucket.
PutBucketLogging	Enables logging for a bucket.
GetBucketLogging	Queries the logging configurations of a bucket.
DeleteBucketLogging	Disables logging for a bucket.
PutBucketWebsite	Enables static website hosting for a bucket.
GetBucketWebsite	Queries the status of the static website hosting for a bucket.
DeleteBucketWebsite	Disables static website hosting for a bucket.
PutBucketReferer	Configures hotlink protection rules for a bucket.
GetBucketReferer	Queries the hotlink protection rules configured for a bucket.
PutBucketTags	Adds tags to a bucket or modifies the tags of a bucket.
GetBucketTags	Queries the tags of a bucket.
DeleteBucketTags	Deletes the tags of a bucket.
PutBucketEncryption	Configures encryption rules for a bucket.
GetBucketEncryption	Queries the encryption rules configured for a bucket.
DeleteBucketEncryption	Deletes the encryption rules configured for a bucket.
PutBucketRequestPayment	Enables pay-by-requester for a bucket.
GetBucketRequestPayment	Queries the pay-by-requester configurations of a bucket.

Object-related operations

API	Description
PutObject	Uploads an object.
CopyObject	Copies an object to another object.
GetObject	Queries an object.
AppendObject	Uploads an object by using append upload.
DeleteObject	Deletes an object.
DeleteMultipleObjects	Deletes multiple objects.
HeadObject	Queries only the metadata of an object but not the object content.
GetObjectMeta	Queries only the basic metadata of an object, including ETag, Size, and LastModified, but not the object content.
PostObject	Uploads an object by using an HTML form.
PutObjectACL	Modifies the ACL of an object.
GetObjectACL	Queries the ACL of an object.
Callback	Enables callback in requests.
PutSymlink	Creates a symbolic link.
GetSymlink	Queries a symbolic link.
RestoreObject	Restores an object.
SelectObject	Queries objects by using SQL statements.
PutObjectTagging	Configures or updates the tags of an object.
GetObjectTagging	Queries the tags of an object.
DeleteObjectTagging	Deletes specified tags of an object.

Operations related to multipart upload

API	Description
InitiateMultipartUpload	Initiates a multipart upload task.
UploadPart	Uploads an object in multiple parts.
UploadPartCopy	Uploads an object by copying parts of an existing object.
CompleteMultipartUpload	Completes the multipart upload task of an object.
AbortMultipartUpload	Cancels a multipart upload task.
ListMultipartUploads	Lists all ongoing multipart upload tasks.
ListParts	Lists all parts that are uploaded in a specified multipart upload task.

Operations related to cross-origin resource sharing (CORS) operations

API	Description
PutBucketCors	Configures CORS rules for a bucket.
GetBucketCors	Queries the CORS rules configured for a bucket.
DeleteBucketCors	Disables CORS for a bucket and deletes all CORS rules configured for the bucket.
OptionObject	Specifies preflight requests for cross-origin access.

Operations related to LiveChannel

API	Description
PutLiveChannelStatus	Switches the status of a LiveChannel.
PutLiveChannel	Creates a LiveChannel.
GetVodPlaylist	Queries the playlist of a LiveChannel.
PostVodPlaylist	Creates a playlist for a LiveChannel.
Get LiveChannelStat	Queries the ingestion status of a LiveChannel.
GetLiveChannelInfo	Queries the configurations of a LiveChannel.
GetLiveChannelHistory	Queries the ingestion history of a LiveChannel.
ListLiveChannel	Lists LiveChannels.
DeleteLiveChannel	Deletes a LiveChannel.