接口功能介绍
设置对象的访问权限控制列表（ACL）
接口约束
支持的线上资源池 ：上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
URI
POST /v4/oss/put-object-acl
请求参数
请求体 JSON Body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| key | 是 | String | 对象名 | obj1 |
| versionID | 否 | String | 版本ID，在开启多版本时可使用 | USzD.sN0vODAsQ84ncdT20oRiY2lFCD |
| regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| ACL | 否 | String | ACL 配置，允许的值为 private, public-read, public-read-write, authenticated-read。不能与accessControlPolicy 同时使用。 | private |
| accessControlPolicy | 否 | Object | 访问控制策略，不能与 ACL 参数同时使用 | 见下级对象 |
表 accessControlPolicy
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| owner | 是 | Object | 所有者 | 见下级对象 |
| grants | 是 | Array of Objects | 授权信息 | 见下级对象 |
表 owner
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| displayName | 是 | String | 展示名称 | dname1 |
| ID | 是 | String | 用户名 | user1 |
表 grants
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| grantee | 是 | Object | 被授予权限的人的容器 | 见下级对象 |
| permission | 是 | String | 权限，为 WRITE, WRITE_ACP, FULL_CONTROL, READ, READ_ACP 之中的值 WRITE：向桶中写对象的权限 WRITE_ACP：修改桶的访问控制权限的能力 READ：读取桶中文件列表的能力 READ_ACP：获取桶的访问控制权限的能力 FULL_CONTROL：同桶的所属者相同的权限，以上能力都具有 |
FULL_CONTROL |
表 grantee
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| emailAddress | 否 | String | 邮箱地址 | example@ctyun.cn |
| type | 是 | String | 用户类型， CanonicalUser，AmazonCustomerByEmail，Group 三者之一。type 为 CanonicalUser 时，必填 ID；为 AmazonCustomerByEmail，必填 emailAddress；为 Group 必填URI。另外，使用 AmazonCustomerByEmail 时，将会保存其指向到的 CanonicalUser 类型的用户 | CanonicalUser |
| displayName | 否 | String | 展示名称 | dname2 |
| ID | 否 | String | 用户名 | user2 |
| URI | 否 | String | URI，不存在时为 null | http://acs.amazonaws.com/groups/global/AuthenticatedUsers |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| description | String | 状态描述，一般为中文 | 成功 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
请求示例
{
"bucket": "bucket1",
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"key": "obj1",
"versionID": "USzD.sN0vODAsQ84ncdT20oRiY2lFCD",
"accessControlPolicy": {
"owner": {
"displayName": "dname1",
"ID": "user1"
},
"grants": [
{
"grantee": {
"displayName": "dname2",
"emailAddress": "https://example@ctyun.cn/xxxx",
"ID": "user2",
"type": "CanonicalUser"
},
"permission": "FULL_CONTROL"
}
]
}
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求失败。 |
错误码
errorCode 枚举值，见错误码总表
