Object Metadata Overview

Object metadata is a set of name-value pairs that describe the object and is used for object management.

Currently, only the metadata defined by the system is supported.

The metadata defined by the system is classified into the following types: system-controlled and user-controlled. For example, metadata such as Last-Modified is controlled by the system and cannot be modified. You can call the API to modify the metadata such as ContentLanguage. The metadata that can be modified is described as follows:

Table 1 OBS metadata

Name

Description

ContentDisposition

Provides a default file name for the object that is being requested. When an object is being downloaded or accessed, the file with the default file name is directly displayed in the browser or a download dialog box is displayed if the file is being accessed.

For example, select ContentDisposition as the metadata name and enter attachment;filename="testfile.xls" as the metadata value for an object. If you access the object through a link, a dialog box is directly displayed for downloading objects, and the object name is changed to testfile.xls. For details, see the definition about ContentDisposition in HTTP.

ContentLanguage

Indicates the language or languages intended for the audience. Therefore, a user can differentiate according to the user's preferred language. For details, see the definition about ContentLanguage in HTTP.

WebsiteRedirectLocation

Redirects an object to another object or an external URL. The redirection function is implemented using static website hosting.

For example, you can perform the following operations to implement object redirection:

  1. Set metadata of object testobject.html in the root directory of bucket testbucket. Select WebsiteRedirectLocation for Name and enter http://www.example.com for Value.

    Note

    OBS only supports redirection for objects in the root directory of a bucket. Redirection for objects located in folders of a bucket is not supported.

  2. Configure static website hosting for bucket testbucket, and set the object testobject.html in the bucket as the default home page of the hosted static website.

  3. If you access object testobject.html through the URL link provided on the Configure Static Website Hosting page, the access request is redirected to http://www.example.com.

ContentEncoding

Content encoding format when an object is downloaded. The options are as follows:

  • Standard: compress, deflate, exi, identity, gzip, and pack200-gzip

  • Others: br, bzip2, lzma, peerdist, sdch, xpress, xz

CacheControl

Cache behavior of the web page when the specified object is downloaded.

  • Cacheability: public, private, no-cache, and only-if-cached

  • Expiration time: max-age=<seconds>, s-maxage=<seconds>, max-stale[=<seconds>], min-fresh=<seconds>, stale-while-revalidate=<seconds>, stale-if-error=<seconds>

  • Re-verification and reloading: must-revalidate, proxy-revalidate, immutable

  • Others: no-store, no-transform

Expires

Cache expiration time (GMT)

ContentType

File type of an object. For details, see About Object Metadata Content-Type.

Note

  • When versioning is enabled for a bucket, you can set metadata for objects which are Latest Version, but cannot set metadata for objects which are Historical Version.

  • Metadata cannot be configured for Cold objects.

last updated: 2024-12-11 10:27 UTC - commit: 1084b97f9d241d7af788bdfaa536dba9679533f7