接口介绍
获取对象的访问权限控制列表(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
GET /v4/oss/get-object-acl
请求参数
请求 Query 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
bucket | 是 | String | 桶名 | bucket1 |
key | 是 | String | 对象名 | obj1 |
versionID | 否 | String | 版本ID,在开启多版本时可使用 | USzD.sN0vODAsQ84ncdT20oRiY2lFCD |
regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
description | String | 状态描述,一般为中文 | 成功 |
returnObj | Object | 响应对象 | 见下级对象 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
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,Group 二者之一 | CanonicalUser |
displayName | String | 展示名称 | dname2 |
ID | String | 用户名 | user2 |
URI | String | URI,不存在时为 null | http://acs.amazonaws.com/groups/global/AuthenticatedUsers |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-object-acl?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0&key=obj1&versionID=USzD.sN0vODAsQ84ncdT20oRiY2lFCD
响应示例
{
"returnObj": {
"owner": {
"displayName": "dname1",
"ID": "user1"
},
"grants": [
{
"grantee": {
"displayName": "dname2",
"emailAddress": "example@ctyun.cn",
"ID": "user2",
"type": "CanonicalUser"
},
"permission": "FULL_CONTROL"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表