Help Center/ Object Storage Service/ SDK Reference/ Node.js/ Object Management (SDK for Node.js)/ Obtaining the ACL of an Object (SDK for Node.js)
Updated on 2024-11-26 GMT+08:00
View PDF
Share

Obtaining the ACL of an Object (SDK for Node.js)

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

Function

This API returns the ACL of an object.

Restrictions

Method

ObsClient.getObjectAcl(params)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

Bucket

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 a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets with 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.

Value range:

The value can contain 3 to 63 characters.

Default value:

None

Key

string

Yes

Explanation:

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object that does not contain the bucket name.

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

Restrictions:

None

Value range:

The value can contain 1 to 1,024 characters.

Default value:

None

VersionId

string

No

Explanation:

Object version ID, for example, G001117FCE89978B0000401205D5DC9A

Restrictions:

None

Value range:

The value must contain 32 characters.

Default value:

None

Responses

Table 2 Responses

Type

Description

Table 3

NOTE:

This API returns a Promise response, which requires the Promise or async/await syntax.

Explanation:

Returned results. For details, see Table 3.
Table 3 Response

Parameter

Type

Description

CommonMsg

ICommonMsg

Explanation:

Common information generated after an API call is complete, including the HTTP status code and error code. For details, see Table 4.

InterfaceResult

Table 5

Explanation:

Results outputted for a successful call. For details, see Table 5.

Restrictions:

This parameter is not included if the value of Status is greater than 300.
Table 4 ICommonMsg

Parameter

Type

Description

Status

number

Explanation:

HTTP status code returned by the OBS server.

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 details, see Status Codes.

Code

string

Explanation:

Error code returned by the OBS server.

Message

string

Explanation:

Error description returned by the OBS server.

HostId

string

Explanation:

Request server ID returned by the OBS server.

RequestId

string

Explanation:

Request ID returned by the OBS server.

Id2

string

Explanation:

Request ID2 returned by the OBS server.

Indicator

string

Explanation:

Error code details returned by the OBS server.
Table 5 GetObjectAclOutput

Parameter

Type

Description

RequestId

string

Explanation:

Request ID returned by the OBS server

VersionId

string

Explanation:

Object version ID, for example, G001117FCE89978B0000401205D5DC9A

Owner

Owner

Explanation:

Object owner. For details, see Owner.

Delivered

string

Explanation:

Whether the bucket ACL is applied to the objects in the bucket.

Grants

Grant[]

Explanation:

Grantees' permission information. For details, see Table 7.
Table 6 Owner

Parameter

Type

Mandatory (Yes/No)

Description

ID

string

Yes if used as a request parameter

Explanation:

Account (domain) ID of the owner

Value range:

To obtain the account ID, see How Do I Get My Account ID and User ID? (SDK for Node.js).

Default value:

None

DisplayName

string

No

Explanation:

Account name of the owner

Default value:

None
Table 7 Grant

Parameter

Type

Mandatory (Yes/No)

Description

Grantee

Grantee

Yes if used as a request parameter

Explanation:

Grantee information. For details, see Table 8.

Permission

PermissionType

Yes if used as a request parameter

Explanation:

Granted permission

Value range:

See Table 11.
Table 8 Grantee

Parameter

Type

Mandatory (Yes/No)

Description

Type

string

Yes if used as a request parameter

Explanation:

Grantee type

Value range:

See Table 9.

Default value:

None

ID

string

Yes if this parameter is used as a request parameter and Type is set to a user

Explanation:

Account (domain) ID of the grantee.

Value range:

To obtain the account ID, see How Do I Get My Account ID and User ID? (SDK for Node.js).

Default value:

None

Name

string

No if used as a request parameter

Explanation:

Account name of the grantee.

Restrictions:

  • The account name cannot contain full-width characters.
  • The account name starts with a letter.
  • The account name contains 6 to 32 characters.
  • The account name contains only letters, digits, hyphens (-), or underscores (_).

Default value:

None

URI

GroupUriType

Yes if this parameter is used as a request parameter and Type is set to a group

Explanation:

Authorized user group

Value range:

See Table 10.

Default value:

None
Table 9 GranteeType

Constant

Description

Group

Grants permissions to user groups.

CanonicalUser

Grants permissions to individual users.
Table 10 GroupUriType

Constant

Default Value

Description

ObsClient.enums.GroupAllUsers

AllUsers

All users.

ObsClient.enums.GroupAuthenticatedUsers

AuthenticatedUsers

Authorized users. This constant is deprecated.

ObsClient.enums.GroupLogDelivery

LogDelivery

Log delivery group. This constant is deprecated.
Table 11 PermissionType

Constant

Default Value

Description

ObsClient.enums.PermissionRead

READ

A grantee with this permission for a bucket can obtain the list of objects, multipart uploads, bucket metadata, and object versions in the bucket.

A grantee with this permission for an object can obtain the object content and metadata.

ObsClient.enums.PermissionWrite

WRITE

A grantee with this permission for a bucket can upload, overwrite, and delete any object or part in the bucket.

This permission is not applicable to objects.

ObsClient.enums.PermissionReadAcp

READ_ACP

A grantee with this permission can obtain the ACL of a bucket or object.

A bucket or object owner has this permission for their bucket or object by default.

ObsClient.enums.PermissionWriteAcp

WRITE_ACP

A grantee with this permission can update the ACL of a bucket or object.

A bucket or object owner has this permission for their bucket or object by default.

This permission allows the grantee to change the access control policies, meaning the grantee has full control over a bucket or object.

ObsClient.enums.PermissionFullControl

FULL_CONTROL

A grantee with this permission for a bucket has PermissionRead, PermissionWrite, PermissionReadAcp, and PermissionWriteAcp permissions for the bucket.

A grantee with this permission for an object has PermissionRead, PermissionReadAcp, and PermissionWriteAcp permissions for the object.

Code Examples

This example returns the ACL of object example/objectname.

 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 the OBS library.
// Use npm to install the client.
const ObsClient = require("esdk-obs-nodejs");
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
const obsClient = new ObsClient({
  // Obtain an AK/SK pair using environment variables 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.
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // (Optional) If you use 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. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
  // security_token: process.env.SECURITY_TOKEN,
  // Enter the endpoint corresponding to the region where the bucket is located. CN-Hong Kong is used here in this example. Replace it with the one currently in use.
  server: "https://obs.ap-southeast-1.myhuaweicloud.com"
});

async function getObjectAcl() {
  try {
    const params = {
      // Specify the bucket name.
      Bucket: "examplebucket",
      // Specify the object (example/objectname in this example).
      Key: 'example/objectname',
    };
    // Obtain the object ACL.
    const result = await obsClient.getObjectAcl(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get object(%s)'s acl successful with bucket(%s)!", params.Key, params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      console.log('Owner[ID]: %s', result.InterfaceResult.Owner.ID);
      console.log('Owner[Name]: %s', result.InterfaceResult.Owner.Name);
      for (let i = 0; i < result.InterfaceResult.Grants.length; i++) {
        const grant = result.InterfaceResult.Grants[i];
        fmt.Printf("Grant[%d]-Type:%s, ID:%s, URI:%s, Permission:%s\n",
          index, grant.Grantee.Type, grant.Grantee.ID, grant.Grantee.URI, grant.Permission)
      };
      return;
    };
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  };
};

getObjectAcl();