Updated on 2024-01-26 GMT+08:00

Obtaining Bucket Tags (SDK for Java)

Function

If you add tags to a bucket, SDRs generated for the requests sent to this bucket will include these tags, so you can use the tags to classify SDRs for detailed cost analysis. For example, if you have an application that uploads its running data to a bucket, you can tag the bucket with the application name. In this manner, the costs of the application can be analyzed using tags in SDRs.

This API returns the tags of a bucket.

If you have any questions during development, post them on the Issues page of GitHub.

Restrictions

Method

obsClient.getBucketTagging(final BaseBucketRequest request)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

BaseBucketRequest

Yes

Explanation:

Request parameters related to basic bucket information. For details, see Table 2.

Table 2 BaseBucketRequest

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

String

Yes

Explanation:

Bucket name.

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Default value:

None

Responses

Table 3 BucketTagInfo

Parameter

Type

Description

tagSet

TagSet

Explanation:

Tag set. For details, see Table 4.

statusCode

int

Explanation:

HTTP status code.

Value range:

A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response.

For more information, see Status Code.

Default value:

None

responseHeaders

Map<String, Object>

Explanation:

HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header.

Default value:

None

Table 4 TagSet

Parameter

Type

Description

tags

List<Tag>

Explanation:

Tag list. For details, see Table 5.

Table 5 Tag

Parameter

Type

Mandatory (Yes/No)

Description

key

String

Yes

Explanation:

Tag key.

Restrictions:

  • The tag key in the same bucket must be unique.
  • You can define tags or select the ones predefined on TMS.
  • The value must contain 1 to 36 characters.
  • Unicode is supported.
  • The value cannot start or end with a space or contain commas (,), asterisks (*), vertical bars (|), slashes (/), less-than signs (<), greater-than signs (>), equal signs (=), backslashes (\), or control characters in ASCII from 0x00 to 0x1F.
  • The value is case-sensitive.

Default value:

None

value

String

Yes

Explanation:

Tag value.

Restrictions:

  • A tag value can be duplicate or left blank.
  • The value must contain 0 to 43 characters.
  • Unicode is supported.
  • The value cannot contain commas (,), asterisks (*), vertical bars (|), slashes (/), less-than signs (<), greater-than signs (>), equal signs (=), backslashes (\), or control characters in ASCII from 0x00 to 0x1F.
  • The value is case-sensitive.

Default value:

None

Code Examples

This example returns tags of bucket examplebucket using obsClient.getBucketTagging.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketTagInfo;
public class GetBucketTagging001
{
    public static void main(String[] args) {
        // 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.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one in your actual situation.
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // Obtain an endpoint using environment variables or import it in other ways.
        //String endPoint = System.getenv("ENDPOINT");
        
        // Create an ObsClient instance.
        // Use the permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // Use the temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // Obtain bucket tags.
            BucketTagInfo bucketTagInfo = obsClient.getBucketTagging("examplebucket");
            for(BucketTagInfo.TagSet.Tag tag : bucketTagInfo.getTagSet().getTags()){
                System.out.println("\t" + tag.getKey() + ":" + tag.getValue());}
            System.out.println("getBucketTagging successfully");
        } catch (ObsException e) {
            System.out.println("getBucketTagging failed");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("getBucketTagging failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}