使用PHP SDK管理文件访问权限

本文介绍如何使用PHP SDK V2设置并获取文件的访问权限(ACL)。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 要设置Object访问权限,您必须具有oss:PutObjectAcl权限;要获取Object访问权限,您必须具有oss:GetObjectAcl权限。具体操作,请参见RAM用户授予自定义的权限策略

读写权限类型

文件的访问权限(ACL)有以下四种:

访问权限

描述

访问权限值

继承Bucket

文件遵循存储空间的访问权限。

oss.ObjectACLDefault

私有

文件的拥有者和授权用户有该文件的读写权限,其他用户没有权限操作该文件。

oss.ObjectACLPrivate

公共读

文件的拥有者和授权用户有该文件的读写权限,其他用户只有文件的读权限。请谨慎使用该权限。

ObjectACLPublicRead

公共读写

所有用户都有该文件的读写权限。请谨慎使用该权限。

oss.ObjectACLPublicReadWrite

文件的访问权限优先级高于存储空间的访问权限。例如存储空间的访问权限是私有,而文件的访问权限是公共读写,则所有用户都有该文件的读写权限。如果某个文件没有设置过访问权限,则遵循存储空间的访问权限。

示例代码

1.设置文件的读写权限

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True],
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False],
    "bucket" => ['help' => 'The name of the bucket', 'required' => True],
    "key" => ['help' => 'The name of the object', 'required' => True],
];

// 构建长选项格式(如 --region:),供 getopt 解析使用
$longopts = array_map(function ($key) {
    return "$key:";
}, array_keys($optsdesc));

// 解析命令行参数
$options = getopt("", $longopts);

// 检查必填参数是否缺失
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        // 如果缺少必填参数,打印帮助信息并退出
        $help = $value['help'];
        echo "Error: the following arguments are required: --$key, $help\n";
        exit(1);
    }
}

// 提取参数值
$region = $options["region"];
$bucket = $options["bucket"];
$key = $options["key"];

// 从环境变量中加载凭证(AccessKey ID 和 AccessKey Secret)
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// 加载默认配置并设置凭证提供者、地域
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider);
$cfg->setRegion($region);

// 如果指定了 endpoint,则设置自访问地址
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]);
}

// 初始化 OSS 客户端
$client = new Oss\Client($cfg);

// 创建 PutObjectAclRequest 请求对象,设置 Bucket 名称、Object Key 和 ACL 权限类型
$request = new Oss\Models\PutObjectAclRequest($bucket, $key, Oss\Models\ObjectACLType::PUBLIC_READ);

// 发起请求,设置对象的 ACL 为 public-read(公共可读)
$result = $client->putObjectAcl($request);

// 打印响应结果中的状态码和请求 ID
printf(
    'status code:' . $result->statusCode . PHP_EOL .
    'request id:' . $result->requestId
);

2.获取文件的读写权限

<?php

// 引入自动加载文件 加载依赖库
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// 定义命令行参数描述
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located', 'required' => True], // 区域是必填项 存储空间所在的区域
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS', 'required' => False], // 访问域名是可选项 其他服务可以用来访问OSS的域名
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // 存储空间名称是必填项
    "key" => ['help' => 'The name of the object', 'required' => True], // 对象名称是必填项
];

// 生成长选项列表 用于解析命令行参数
$longopts = \array_map(function ($key) {
    return "$key:"; // 每个参数后面加冒号 表示需要值
}, array_keys($optsdesc));

// 解析命令行参数
$options = getopt("", $longopts); 

// 检查必填参数是否缺失
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help'];
        echo "Error: the following arguments are required: --$key, $help"; // 提示用户缺少必填参数
        exit(1); 
    }
}

// 获取命令行参数值
$region = $options["region"]; // 存储空间所在区域
$bucket = $options["bucket"]; // 存储空间名称
$key = $options["key"]; // 对象名称

// 使用环境变量加载凭证信息 AccessKeyId 和 AccessKeySecret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();

// 设置凭证提供者
$cfg->setCredentialsProvider($credentialsProvider);

// 设置区域
$cfg->setRegion($region);

// 如果提供了访问域名 则设置访问域名
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]);
}

// 创建OSS客户端实例
$client = new Oss\Client($cfg);

// 创建获取对象ACL的请求对象
$request = new Oss\Models\GetObjectAclRequest(bucket: $bucket, key: $key);

// 调用getObjectAcl方法获取对象的ACL
$result = $client->getObjectAcl($request);

// 打印返回结果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP响应状态码
    'request id:' . $result->requestId . PHP_EOL . // 请求的唯一标识
    'acl:' . $result->accessControlList->grant // 对象的ACL权限
);

相关文档

  • 关于设置文件读写权限的完整示例代码,请参见GitHub示例

  • 关于设置文件读写权限的API接口,请参见PutObjectACL

  • 关于获取文件读写权限的完整示例代码,请参见GitHub示例

  • 关于获取文件读写权限的API接口,请参见GetObjectACL