Setting Object Tags

Function

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

If there is no object version ID (indicated by versionId) contained in the request, you must have the PutObjectTagging permission. If there is an object version ID (indicated by versionId) contained in the request, you must have both the PutObjectTagging and PutObjectVersionTagging permissions. By default, only an object owner can perform this operation. The object owner can use bucket or user policies to grant others permissions to perform this operation.

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: =*<>\,|/

Code Examples

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

// Import a dependency library.
require 'vendor/autoload.php';
// Use the source code to import the SDK code library.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
// Create an ObsClient instance.
$obsClient = new ObsClient ( [ 
      //Obtain an AK/SK pair using environment variables or import the 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',
] );

$resp = $obsClient -> setObjectTagging([
      'Bucket' => 'bucketname',
      'Key' => 'objectname',
      'Tags' => [
           ['Key' => 'tag1', 'Value' => 'value1'],
           ['Key' => 'tag2', 'Value' => 'value2']
       ]
]);

printf ( "RequestId:%s\n", $resp ['RequestId'] );