All Products
Search
Document Center

Object Storage Service:List of operations by function

Last Updated:Dec 15, 2023

The following tables list API operations available for use in Object Storage Service (OSS).

Service-level operation

Operation

Description

ListBuckets (GetService)

Queries all buckets that are owned by the requester.

ListUserDataRedundancyTransition

Lists all redundancy type change tasks of the requester.

Region operation

Operation

Description

DescribeRegions

Queries the endpoints of all supported regions or the endpoints of a specific region.

Bucket operations

Category

Operation

Description

Basic operations

PutBucket

Creates a bucket.

DeleteBucket

Deletes a bucket.

ListObjects (GetBucket)

Queries the information about all objects in a bucket.

ListObjectsV2 (GetBucketV2)

GetBucketInfo

Queries bucket information.

GetBucketLocation

Queries the region in which a bucket is located.

GetBucketStat

Queries the storage capacity of a bucket and the number of objects in the bucket.

Retention policy

InitiateBucketWorm

Creates a retention policy.

AbortBucketWorm

Deletes an unlocked retention policy.

CompleteBucketWorm

Locks a retention policy.

ExtendBucketWorm

Extends the retention period (days) of objects in a bucket for which a retention policy is locked.

GetBucketWorm

Queries the retention policies of a bucket.

Access control list (ACL)

PutBucketAcl

Configures the ACL for a bucket.

GetBucketAcl

Queries the ACL of a bucket.

Lifecycle

PutBucketLifecycle

Configures lifecycle rules for objects in a bucket.

GetBucketLifecycle

Queries the lifecycle rules that are configured for objects in a bucket.

DeleteBucketLifecycle

Deletes lifecycle rules configured for objects in a bucket.

Transfer acceleration

PutBucketTransferAcceleration

Configures transfer acceleration for a bucket.

GetBucketTransferAcceleration

Queries the transfer acceleration configurations of a bucket.

Versioning

PutBucketVersioning

Configures versioning for a bucket.

GetBucketVersioning

Queries the versioning status of a bucket.

ListObjectVersions (GetBucketVersions)

Queries the versions of all objects in a bucket.

Data replication

PutBucketReplication

Configures data replication rules for a bucket.

PutBucketRTC

Enables or disables Replication Time Control (RTC) for existing cross-region replication (CRR) rules.

GetBucketReplication

Queries the data replication rules that are configured for a bucket.

GetBucketReplicationLocation

Queries the regions in which the destination bucket can be located.

GetBucketReplicationProgress

Queries the data replication progress of a bucket.

DeleteBucketReplication

Stops the data replication tasks of a bucket and deletes the data replication configurations of the bucket.

Bucket policy

PutBucketPolicy

Configures a bucket policy.

GetBucketPolicy

Queries the policies that are configured for a bucket.

DeleteBucketPolicy

Deletes a bucket policy.

Inventory

PutBucketInventory

Configures inventories for a bucket.

GetBucketInventory

Queries specific inventories that are configured for a bucket.

ListBucketInventory

Queries all inventories that are configured for a bucket.

DeleteBucketInventory

Deletes specific inventories of a bucket.

Logging

PutBucketLogging

Enables logging for a bucket.

GetBucketLogging

Queries the logging configurations of a bucket.

DeleteBucketLogging

Disables logging for a bucket.

Static website hosting

PutBucketWebsite

Enables static website hosting for a bucket.

GetBucketWebsite

Queries the status of static website hosting for a bucket.

DeleteBucketWebsite

Disables static website hosting for a bucket.

Hotlink protection

PutBucketReferer

Configures hotlink protection for a bucket.

GetBucketReferer

Queries the hotlink protection configurations of a bucket.

Tag

PutBucketTags

Adds tags to or modifies the tags of a bucket.

GetBucketTags

Queries the tags of a bucket.

DeleteBucketTags

Deletes the tags of a bucket.

Encryption

PutBucketEncryption

Configures encryption rules for a bucket.

GetBucketEncryption

Queries the encryption rules that are configured for a bucket.

DeleteBucketEncryption

Deletes the encryption rules that are configured for a bucket.

Pay-by-requester

PutBucketRequestPayment

Enables pay-by-requester for a bucket.

GetBucketRequestPayment

Queries the pay-by-requester configurations of a bucket.

CORS

PutBucketCors

Configures cross-origin resource sharing (CORS) rules for a bucket.

GetBucketCors

Queries the CORS rules that are configured for a bucket.

DeleteBucketCors

Disables CORS for a bucket and deletes all CORS rules.

Options

Sends a preflight (OPTIONS) request by the browser to indicate a specific origin, HTTP method, and headers that will be used in the actual request, in order to check whether OSS permits the actual cross-origin request.

Access tracking

PutBucketAccessMonitor

Configures access tracking for a bucket.

GetBucketAccessMonitor

Queries the access tracking status of a bucket.

Data indexing

OpenMetaQuery

Enables the metadata management feature for a bucket.

GetMetaQueryStatus

Queries the metadata index library of a bucket.

DoMetaQuery

Queries objects that meet specific conditions and lists the object information based on specific fields and sorting methods.

CloseMetaQuery

Disables the metadata management feature for a bucket.

Anti-DDoS

InitUserAntiDDosInfo

Creates Anti-DDoS instances.

UpdateUserAntiDDosInfo

Changes the status of an Anti-DDoS instance.

GetUserAntiDDosInfo

Queries information about Anti-DDoS instances that belong to a specific Alibaba Cloud account.

InitBucketAntiDDosInfo

Initializes Anti-DDoS instances for a bucket.

UpdateBucketAntiDDosInfo

Updates the status of Anti-DDoS instances of a bucket.

ListBucketAntiDDosInfo

Queries the protection list of an Anti-DDoS instance of a bucket.

Resource group

PutBucketResourceGroup

Configures a resource group for a bucket.

GetBucketResourceGroup

Queries the ID of the resource group to which a bucket belongs.

CNAME

CreateCnameToken

Creates a CNAME token used to verify the ownership of a domain name.

GetCnameToken

Queries existing CNAME tokens.

PutCname

Maps a custom domain name to a bucket.

ListCname

Queries the list of custom domain names mapped to a specific bucket.

DeleteCname

Deletes the custom domain names mapped to a specific bucket.

Image style

PutStyle

Creates an image style.

GetStyle

Queries information about a specific image style in a bucket.

ListStyle

Queries all image styles of a bucket.

DeleteStyle

Deletes a specific image of a bucket.

Real-time access of Archive objects

PutBucketArchiveDirectRead

Enables or disables real-time access of Archive objects for a bucket.

GetBucketArchiveDirectRead

Queries whether real-time access of Archive objects is enabled for a bucket.

TLS

PutBucketHttpsConfig

Enables or disables Transport Layer Security (TLS) version management for a bucket.

GetBucketHttpsConfig

Queries the TLS version configurations of a bucket.

Access point

CreateAccessPoint

Creates an access point.

GetAccessPoint

Queries the information about an access point.

DeleteAccessPoint

Deletes an access point.

ListAccessPoints

Queries the information about user-level or bucket-level access points.

PutAccessPointPolicy

Configures an access point policy.

GetAccessPointPolicy

Queries the configuration of an access point policy.

DeleteAccessPointPolicy

Deletes an access point policy.

Object FC Access Point

CreateAccessPointForObjectProcess

Creates an Object FC Access Point.

GetAccessPointForObjectProcess

Queries basic information about an Object FC Access Point.

DeleteAccessPointForObjectProcess

Deletes an Object FC Access Point.

ListAccessPointsForObjectProcess

Queries information about user-level Object FC Access Points.

PutAccessPointConfigForObjectProcess

Changes the configurations of an Object FC Access Point.

GetAccessPointConfigForObjectProcess

Queries the configurations of an Object FC Access Point.

PutAccessPointPolicyForObjectProcess

Configures permission policies for an Object FC Access Point.

GetAccessPointPolicyForObjectProcess

Queries the permission policies of an Object FC Access Point.

DeleteAccessPointPolicyForObjectProcess

Deletes the permission policies of an Object FC Access Point.

WriteGetObjectResponse

Specifies the return data and response headers for a GetObject request.

Redundancy type change

CreateBucketDataRedundancyTransition

Creates a redundancy type change task.

GetBucketDataRedundancyTransition

Queries redundancy type change tasks.

DeleteBucketDataRedundancyTransition

Deletes a redundancy type change task.

ListBucketDataRedundancyTransition

Lists all redundancy type change tasks in a bucket.

Object operations

Category

APi

Description

Basic operations

PutObject

Uploads an object.

GetObject

Queries an object.

CopyObject

Copies an object.

AppendObject

Uploads an object by using append upload.

DeleteObject

Deletes an object.

DeleteMultipleObjects

Deletes multiple objects at a time.

HeadObject

Queries only the metadata of an object.

GetObjectMeta

Queries only the basic metadata of an object, including ETag, size, and last modified time.

PostObject

Uploads an object by using an HTML form.

Callback

Performs a callback by sending a request that contains callback parameters to OSS.

RestoreObject

Restores Archive, Cold Archive, or Deep Cold Archive objects.

SelectObject

Executes SQL statements on an object and queries the execution results.

CreateSelectObjectMeta

Queries the total number of rows in an object and the number of splits. For a CSV object, the total number of columns in the object can also be queried.

Directory management

CreateDirectory

Creates a directory.

Rename

Renames a directory or an object.

DeleteDirectory

Deletes a directory.

Multipart upload

InitiateMultipartUpload

Initiates a multipart upload task.

UploadPart

Uploads an object by part based on the specified object name and the upload ID.

UploadPartCopy

Copies data from an existing object to upload a part by adding the x-oss-copy-source request header to an UploadPart request.

CompleteMultipartUpload

Completes the multipart upload task of an object.

AbortMultipartUpload

Cancels a multipart upload task and deletes the uploaded parts.

ListMultipartUploads

Lists all ongoing multipart upload tasks, which include tasks that are initiated but are not completed or canceled.

ListParts

Lists all parts uploaded by a multipart upload task that has the specified upload ID.

ACL

PutObjectACL

Modifies the ACL of an object.

GetObjectACL

Queries the ACL of an object.

Symbolic link

PutSymlink

Creates a symbolic link.

GetSymlink

Queries a symbolic link.

Tagging

PutObjectTagging

Configures tags for or updates the tags of an object.

GetObjectTagging

Queries the tags of an object.

DeleteObjectTagging

Deletes the tags of an object.

LiveChannel operations

Operation

Description

PutLiveChannelStatus

Changes the state of a LiveChannel.

PutLiveChannel

Creates a LiveChannel.

GetVodPlaylist

Queries the playlist of a LiveChannel.

PostVodPlaylist

Creates a playlist for a LiveChannel.

GetLiveChannelStat

Queries the stream ingest state of a LiveChannel.

GetLiveChannelInfo

Queries the configurations of a LiveChannel.

GetLiveChannelHistory

Queries the stream ingest history of a LiveChannel.

ListLiveChannel

Lists LiveChannels.

DeleteLiveChannel

Deletes a LiveChannel.