tencent cloud

All product documents
Cloud Object Storage
DocumentationCloud Object StorageSDK DocumentationiOS SDKData ManagementObject Tagging
Object Tagging
Download PDF
Last updated: 2024-01-23 17:15:08
Object Tagging
Last updated: 2024-01-23 17:15:08
Download PDF

Overview

This document provides an overview of APIs and SDK code samples for object tagging.
API
Operation
Description
Tagging an object
Tags an uploaded object.
Querying object tags
Queries all tags of an object.
Deleting object tags
Deletes all tags of an object.

SDK API References

For parameters and method description of all APIs in the SDK, see SDK API Reference.

Tagging an Object

Feature description

This API is used to set tags for an existing object. It can help you group and manage existing object resources by adding key-value pairs as object tags.

Sample code

Objective-C

    QCloudPutObjectTaggingRequest *putReq = [QCloudPutObjectTaggingRequest new];

    // Bucket name in the format of BucketName-APPID, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket.
    putReq.bucket = @"examplebucket-1250000000";

    // Set of tags
    QCloudTagging *taggings = [QCloudTagging new];

    QCloudTag *tag1 = [QCloudTag new];

    // Tag key; this value can contain up to 128 bytes of letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots,
    // colons, and slashes
    tag1.key = @"age";

    // Tag value; this value can contain up to 256 bytes of letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots,
    // colons, and slashes
    tag1.value = @"20";
    QCloudTag *tag2 = [QCloudTag new];
    tag2.key = @"name";
    tag2.value = @"karis";

    // Set of tags. Up to 10 tags are supported
    QCloudTagSet *tagSet = [QCloudTagSet new];
    tagSet.tag = @[tag1,tag2];
    taggings.tagSet = tagSet;

    // Set of tags
    putReq.taggings = taggings;

    [putReq setFinishBlock:^(id outputObject, NSError *error) {
        // outputObject contains all the HTTP response headers
        NSDictionary* info = (NSDictionary *) outputObject;
    }];
    [[QCloudCOSXMLService defaultCOSXML] PutObjectTagging:putReq];
Swift
    let putReq = QCloudPutObjectTaggingRequest()

    // Bucket name in the format of BucketName-APPID, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
    putReq.bucket = "examplebucket-1250000000";

    // Set of tags
    let taggings = QCloudTagging();

    let tag1 = QCloudTag();

    // Tag key; this value can contain up to 128 bytes of letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots,
    // colons, and slashes
    tag1.key = "age";

    // Tag value; this value can contain up to 256 bytes of letters, digits, spaces, plus signs, minus signs, underscores, equal signs, dots,
    // colons, and slashes
    tag1.value = "20";
    let tag2 = QCloudTag();
    tag2.key = "name";
    tag2.value = "karis";

    // Set of tags. Up to 10 tags are supported
    let tagSet = QCloudTagSet();
    tagSet.tag = [tag1,tag2];
    taggings.tagSet = tagSet;

    // Set of tags
    putReq.taggings = taggings;

    req.finishBlock = {(result,error) in
        if let result = result {
            // result contains response headers
        } else {
            print(error!);
        }
    }
    QCloudCOSXMLService.defaultCOSXML().putObjectTagging(putReq);

Querying Object Tags

Feature description

This API is used to query the existing tags of a specified object.

Sample code

Objective-C
    QCloudGetObjectTaggingRequest *getReq = [QCloudGetObjectTaggingRequest new];

    // Bucket name in the format of BucketName-APPID, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket.
    getReq.bucket = @"examplebucket-1250000000";

    [getReq setFinishBlock:^(QCloudTagging * result, NSError * error) {

        // Set of tags
        QCloudTagSet * tagSet = result.tagSet;
    }];
    [[QCloudCOSXMLService defaultCOSXML] GetObjectTagging:getReq];
Swift
    let getReq = QCloudGetObjectTaggingRequest();

    // Bucket name in the format of BucketName-APPID, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
    getReq.bucket = "examplebucket-1250000000";

    req.finishBlock = {(result,error) in
        if let result = result {
            // Set of tags
            let tagSet = result.tagSet;
        } else {
            print(error!);
        }
    }

    QCloudCOSXMLService.defaultCOSXML().getObjectTagging(getReq);

Deleting Object Tags

Note:
The COS iOS SDK version should be v5.9.9 or higher.

Feature description

This API is used to delete the existing tags of a specified object.

Sample request

Objective-C
    QCloudDeleteObjectTaggingRequest *request = [QCloudDeleteObjectTaggingRequest new];

    // File name
    request.object = @"test.png";
    // Bucket name in the format of BucketName-APPID, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
    request.bucket = @"examplebucket-1250000000";
    request.versionId = @"versionId";

    [request setFinishBlock:^(id * result, NSError * error) {

        if(!error){
            // Deletion succeed
        }else{
            // Deletion failed
        }
    }];
    [[QCloudCOSXMLService defaultCOSXML] DeleteObjectTagging:request];
Swift
    let request = QCloudDeleteObjectTaggingRequest();

    // File name
    request.object = "test.png";

    // Bucket name in the format of BucketName-APPID, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket.
    request.bucket = "examplebucket-1250000000";

    request.versionId = "versionId";

    req.finishBlock = {(result,error) in
        if(!error){
            // Deletion succeed
        }else{
            // Deletion failed
        }
    }

    QCloudCOSXMLService.defaultCOSXML().deleteObjectTagging(request);

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon