接口功能介绍
根据资源池ID和权限组的Fuid返回权限组描述信息
接口约束
1.当前接口使用前请使用资源池概况信息查询接口查询带对接的资源池信息,如资源池信息"regionVersion": "v4.0",即可使用;如资源池信息"regionVersion": "v3.0", 则不可使用
2.自2024年11月15日起,本接口会受到IAM权限管控,当子账号或委托调用该接口时,需具备“sfs:permission:get”权限,否则会报权限不足的错误
URI
GET /v4/sfs/permission-group/list-permission-group
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池 ID | 参考[请求示例] | |
permissionGroupFuid | 否 | String | 权限组Fuid | 参考[请求示例] | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1, 50],注:默认值为10 | 10 | |
pageNo | 否 | Integer | 页码,取值范围:正整数(≥1),注:默认值为1 | 1 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
message | String | 响应描述,一般为英文描述 | 参考[响应示例] | |
description | String | 响应描述,一般为中文描述 | 参考[响应示例] | |
returnObj | Object | 参考[returnObj] | returnObj | |
errorCode | String | 业务细分码,为 product.module.code 三段式码,参考[结果码] | 参考[结果码] | |
error | String | 业务细分码,为product.module.code三段式码大驼峰形式 | 参考[结果码] |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
totalCount | Integer | 权限组的总个数 | 1 | |
currentCount | Integer | 当前页记录数目 | 1 | |
list | Array of Objects | 权限组信息列表 | list | |
pageSize | Integer | 每页记录数目 | 10 | |
pageNo | Integer | 页码 | 1 |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
permissionGroupFuid | String | 权限组Fuid | 参考响应示例 | |
createTime | String | 创建时间,UTC 时间 | 参考响应示例 | |
updateTime | String | 更新时间,UTC 时间 | 参考响应示例 | |
userID | String | 租户 ID | 参考响应示例 | |
regionID | String | 所属资源池 ID | 参考响应示例 | |
sfsCount | Integer | 绑定的文件系统个数 | 0 | |
permissionRuleCount | Integer | 权限组规则个数 | 0 | |
permissionGroupIsDefault | Boolean | 是否为默认权限组 | false | |
permissionGroupID | String | 权限组底层 ID | 参考响应示例 | |
permissionGroupName | String | 权限组名称 | ||
permissionGroupDescription | String | 权限组描述 |
枚举参数
无
请求示例
请求url
GET https://sfs-global.ctapi.ctyun.cn/v4/sfs/permission-group/list-permission-group?regionID=81f7728662dd11ec810800155d307d5b&permissionGroupFuid=50ce2d23-5efe-59e9-9584-b5e95728b930
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"list": [
{
"updateTime": "2023-02-19T08:38:19Z",
"sfsCount": 0,
"permissionGroupName": "yyx-pgtest-012",
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"userID": "a7135589f022439c1edefc74b9336f7a",
"permissionGroupFuid": "50ce2d23-5efe-59e9-9584-b5e95728b930",
"permissionGroupIsDefault": false,
"permissionGroupID": "permission_group_0iffjf9rzb545et3",
"permissionRuleCount": 0,
"permissionGroupDescription": "",
"createTime": "2023-02-19T08:38:19Z"
}
],
"pageSize": 10,
"pageNo": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码