接口功能介绍
返回权限组描述信息
接口约束
无
URI
GET /v4/oceanfs/permission-group/list-permission-group
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 参考[请求示例 | |
| permissionGroupFuid | 否 | String | 权限组的Fuid | 参考[请求示例 | |
| pageSize | 否 | Integer | 每页个数。默认为10 | 10 | |
| pageNo | 否 | Integer | 页数。默认为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 | 权限组的总个数 | 100 | |
| currentCount | Integer | 当前页码的元素个数 | 10 | |
| 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 | 绑定的文件系统个数 | 5 | |
| permissionRuleCount | Integer | 绑定的规则个数 | 5 | |
| permissionGroupIsDefault | Boolean | 是否为默认权限组 | 参考[响应示例] | |
| permissionGroupID | String | 权限组底层 id | 参考[响应示例] | |
| permissionGroupName | String | 权限组名称 | 参考[响应示例] | |
| permissionGroupDescription | String | 权限组描述 | 参考[响应示例] |
枚举参数
无
请求示例
请求url
GET https://oceanfs-global.ctapi.ctyun.cn/v4/oceanfs/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
}
状态码
请参考 状态码
错误码
请参考 错误码
