Help Center> Object Storage Service> SDK Reference> Python> Objects-Related APIs> Modifying Object Metadata
View PDF

Modifying Object Metadata

API Description

You can use this API to modify, delete, or add metadata to objects in a bucket.

Method Definition

ObsClient.setObjectMetadata(bucketName, objectKey, metadata, headers, versionId)

Request Parameters

Field

Type

Optional or Mandatory

Description

bucketName

str

Mandatory

Bucket name

objectKey

str

Mandatory

Object name

metadata

dict

Optional

Customized metadata of the object

headers

SetObjectMetadataHeader

Optional

Additional headers of an object

versionId

str

Optional

Object version ID

Returned Results

Type

Description

GetResult

SDK common result object

Sample Code

try:
    from obs import SetObjectMetadataHeader
    
    # Set the object metadata.
    metadata = {'property1' : 'property-value1', 'property2' : 'property-value2'}

    headers = SetObjectMetadataHeader()
    headers.contentType = "Your Content-Type"
   
    resp = obsClient.setObjectMetadata('bucketname', 'objectname', headers=headers, metadata=metadata)
     
    if resp.status < 300: 
        print('requestId:', resp.requestId)
    else: 
        print('errorCode:', resp.errorCode) 
        print('errorMessage:', resp.errorMessage)
except:
    import traceback
    print(traceback.format_exc())
Parent topic: Objects-Related APIs