本文介绍如何使用Harmony SDK设置并获取文件的访问权限(ACL)。
注意事项
关于OSS支持的Region与Endpoint的对应关系,请参见OSS地域和访问域名。
要设置Object访问权限,您必须具有
oss:PutObjectAcl
权限;要获取Object访问权限,您必须具有oss:GetObjectAcl
权限。具体操作,请参见为RAM用户授权自定义的权限策略。
读写权限类型
文件的访问权限(ACL)有以下四种:
访问权限 | 描述 | 访问权限值 |
继承Bucket | 文件遵循存储空间的访问权限。 | default |
私有 | 文件的拥有者和授权用户有该文件的读写权限,其他用户没有权限操作该文件。 | private |
公共读 | 文件的拥有者和授权用户有该文件的读写权限,其他用户只有文件的读权限。请谨慎使用该权限。 | public-read |
公共读写 | 所有用户都有该文件的读写权限。请谨慎使用该权限。 | public-read-write |
文件的访问权限优先级高于存储空间的访问权限。例如存储空间的访问权限是私有,而文件的访问权限是公共读写,则所有用户都有该文件的读写权限。如果某个文件没有设置过访问权限,则遵循存储空间的访问权限。
示例代码
设置文件访问权限
import Client, { EObjectAcl, RequestError } from '@aliyun/oss';
// 创建OSS客户端实例
const client = new Client({
// 请替换为STS临时访问凭证的Access Key ID
accessKeyId: 'yourAccessKeyId',
// 请替换为STS临时访问凭证的Access Key Secret
accessKeySecret: 'yourAccessKeySecret',
// 请替换为STS临时访问凭证的Security Token
securityToken: 'yourSecurityToken',
// 填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou
region: 'oss-cn-hangzhou',
});
// 指定要操作的Bucket名称,请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';
// 指定要设置ACL的对象(文件)名称,请替换为您实际要操作的对象名称
const key = 'yourObjectName';
/**
* 设置对象的访问权限(ACL)。
* 使用putObjectAcl方法为指定对象设置访问权限。
*/
const putObjectAcl = async () => {
try {
// 调用putObjectAcl方法为指定对象设置访问权限
const res = await client.putObjectAcl({
bucket, // Bucket名称
key, // 对象(文件)名称
acl: EObjectAcl.PRIVATE, // 设置对象的ACL权限,此处设置为私有权限
});
// 打印设置ACL的结果
console.log(JSON.stringify(res));
} catch (err) {
// 捕获请求过程中的异常信息
if (err instanceof RequestError) {
// 如果是已知类型的错误,则打印错误代码、错误消息、请求ID、状态码、EC码等信息
console.log('code: ', err.code); // 错误代码
console.log('message: ', err.message); // 错误消息
console.log('requestId: ', err.requestId); // 请求ID
console.log('status: ', err.status); // HTTP状态码
console.log('ec: ', err.ec); // 错误码
} else {
// 打印其他未知类型的错误
console.log('unknown error: ', err);
}
}
};
// 调用putObjectAcl函数执行设置对象ACL的操作
putObjectAcl();
获取文件访问权限
import Client, { RequestError } from '@aliyun/oss';
// 创建OSS客户端实例
const client = new Client({
// 请替换为STS临时访问凭证的Access Key ID
accessKeyId: 'yourAccessKeyId',
// 请替换为STS临时访问凭证的Access Key Secret
accessKeySecret: 'yourAccessKeySecret',
// 请替换为STS临时访问凭证的Security Token
securityToken: 'yourSecurityToken',
// 填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou
region: 'oss-cn-hangzhou',
});
// 指定要操作的Bucket名称,请替换为您实际使用的Bucket名称
const bucket = 'yourBucketName';
// 指定要查询ACL的对象(文件)名称,请替换为您实际要查询的对象名称
const key = 'yourObjectName';
/**
* 获取对象的访问权限(ACL)。
* 使用getObjectAcl方法获取指定对象的访问权限信息。
*/
const getObjectAcl = async () => {
try {
// 调用getObjectAcl方法获取指定对象的访问权限信息
const res = await client.getObjectAcl({
bucket, // Bucket名称
key, // 对象(文件)名称
});
// 打印获取到的ACL信息
console.log(JSON.stringify(res));
} catch (err) {
// 捕获请求过程中的异常信息
if (err instanceof RequestError) {
// 如果是已知类型的错误,则打印错误代码、错误消息、请求ID、状态码、EC码等信息
console.log('code: ', err.code); // 错误代码
console.log('message: ', err.message); // 错误消息
console.log('requestId: ', err.requestId); // 请求ID
console.log('status: ', err.status); // HTTP状态码
console.log('ec: ', err.ec); // 错误码
} else {
// 打印其他未知类型的错误
console.log('unknown error: ', err);
}
}
};
// 调用getObjectAcl函数执行获取对象ACL的操作
getObjectAcl();
该文章对您有帮助吗?