Updated on 2024-05-11 GMT+08:00

Setting Access Labels

Function

This API sets access labels for a PFS directory for permissions control.

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

Restrictions

Method

obsClient.SetAccessLabel(SetAccessLabelRequest request)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

SetAccessLabelRequest

Yes

Explanation:

Request parameters. For details, see Table 2.

Table 2 SetAccessLabelRequest

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

String

Yes

Explanation:

PFS name.

Restrictions:

  • A PFS name must be unique across all accounts and regions.
  • A PFS 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 PFSs with the same name in the same region, no error will be reported and the PFS attributes comply with those set in the first creation request.

Default value:

None

Dir

String

Yes

Explanation:

Directory name. It is the complete path of a directory in a PFS without the PFS name.

For example, if the access path is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt.

Value range:

The value must contain 1 to 1,024 characters.

Default value:

None

RoleLabel

List<String>

Yes

Explanation:

The access label content of a directory.

Restrictions:

  • An access label can contain up to 52 characters. Only digits (0–9), letters (a to z and A to Z), and underscores (_) are allowed.
  • A maximum of 256 access labels can be set for a directory.

Default value:

None

Responses

Table 3 SetAccessLabelResult

Parameter

Type

Description

statusCode

int

Explanation:

HTTP status code.

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors).

For more information, see Status Code.

Default value:

None

Code Examples

This example sets access labels for the Dirname directory in a PFS named examplebucket.

 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
50
51
52
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.fs.accesslabel.*
public class SetAccessLabel{
    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 currently in use.
        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 instance of ObsClient.
        // Use a permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // Use a temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            //Set access labels for the directory.
            SetAccessLabelRequest request = new SetAccessLabelRequest();
            request.setBucketName("examplebucket");
            request.setDir("Dirname");
            List<String> list = Arrays.asList("Role1","Role2",);            
            request.setRoleLabel(list);
            SetAccessLabelRequest result = obsClient.SetAccessLabelRequest(request);
            System.out.println("SetAccessLabel successfully");
            System.out.println("HTTP Code: " + result.getStatusCode());
        } catch (ObsException e) {
            System.out.println("SetAccessLabel 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("SetAccessLabel failed");
            // Print other error details.
            e.printStackTrace();
        }
    }
}