Setting Object Tags

Function

This API is used to set or update tags for an object. Each tag is a key-value pair.

If you do not need to specify a version ID, the PutObjectTagging permission is required. If you need to specify a version ID, the PutObjectTagging and PutObjectVersionTagging permissions are required. By default, only the object owner can perform this operation. The object owner can grant this permission to others by using a bucket policy or a user policy.

By default, tags are added to the current object version. You can specify the versionId parameter to apply tags to a specific object version. If you add tags to a delete marker, 404 Not Found is returned.

• This API is not available for parallel file systems.
• Each object can have up to 10 tags.
• A tag key is case sensitive and must be unique. It cannot start or end with a space, be left blank, or exceed 36 characters. The following characters are not allowed: =*<>\,|/
• A tag value is case sensitive and can be left blank. It cannot start or end with a space or exceed 43 characters. The following characters are not allowed: =*<>\,|/

Sample Code

The following example shows how to add tags to an object.

<?php

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with the source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
use Obs\ObsException;
// Create an ObsClient instance.
$obsClient = new ObsClient([ 
    // Obtain an AK/SK pair using environment variables (recommended) or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    'key' => getenv('ACCESS_KEY_ID'),
    'secret' => getenv('SECRET_ACCESS_KEY'),
    'endpoint' => 'https://your-endpoint',
]);

try {
    $resp = $obsClient->setObjectTagging([
        'Bucket' => 'bucketname',
        'Key' => 'objectname',
        'Tags' => [
            ['Key' => 'tag1', 'Value' => 'value1'],
            ['Key' => 'tag2', 'Value' => 'value2']
        ],
        'VersionId' => 'versionid'
    ]);
    printf( "RequestId:%s\n", $resp['RequestId']);
} catch (ObsException $e) {
    // If the operation fails, obtain the exception details.
    printf("SetObjectTaggingFailed: Status:%d, Code:%s, Message:%s\n", $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
    $obsClient->close();
}