本文介紹如何使用Harmony SDK設定並擷取檔案的存取權限(ACL)。
注意事項
關於OSS支援的Region與Endpoint的對應關係,請參見地區和Endpoint。
要設定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();