接口功能介绍
返回权限组规则描述信息
接口约束
无
URI
GET /v4/oceanfs/permission-rule/list-permission-rule
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 参考[请求示例] | |
| permissionGroupFuid | 否 | String | 权限组 的fuid，permissionGroupFuid和permissionRuleFuid至少存在一个 | 参考[请求示例] | |
| permissionRuleFuid | 否 | String | 权限组规则的fuid，permissionGroupFuid和permissionRuleFuid至少存在一个 | 参考[请求示例] | |
| 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 | 权限组下的规则总数 | 参考[响应示例] | |
| currentCount | Integer | 当前查询到的规则个数 | 参考[响应示例] | |
| list | Array of Objects | 规则列表 | 参考[list] | |
| pageSize | Integer | 每页个数 | 参考[响应示例] | |
| pageNo | Integer | 页数 | 参考[响应示例] |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| permissionRuleFuid | String | 规则的 ID | 参考[响应示例] | |
| updateTime | String | 更新时间。utc 时间 | 参考[响应示例] | |
| userID | String | 租户 ID | 参考[响应示例] | |
| regionID | String | 资源池 ID。中间层用的 | 参考[响应示例] | |
| permissionGroupID | String | 权限组底层 id。不用关心 | 参考[响应示例] | |
| permissionGroupFuid | String | 权限组 fuid | 参考[响应示例] | |
| permissionRuleID | String | 权限组规则底层 id | 参考[响应示例] | |
| authAddr | String | 授权地址，可用于区分子网及具体虚机等 | 参考[响应示例] | |
| rwPermission | String | 读写权限控制 | 参考[响应示例] | |
| userPermission | String | nfs 访问用户映射 | 参考[响应示例] | |
| permissionRulePriority | Integer | 优先级 | 参考[响应示例] | |
| permissionRuleIsDefault | Boolean | 是否为默认规则 | 参考[响应示例] |
枚举参数
无
请求示例
请求url
GET https://oceanfs-global.ctapi.ctyun.cn/v4/oceanfs/permission-rule/list-permission-rule?regionID=81f7728662dd11ec810800155d307d5b&permissionGroupFuid=00fa1424-ba4c-5f9b-be30-65014dc21ab5&permissionRuleFuid=3d69c5b8-699a-53c4-bd85-d70e93a658eb
请求头header
无
请求体body
无
响应示例
{
"returnObj":{
"totalCount":1,
"currentCount":1,
"list":[
{
"rwPermission":"ro",
"updateTime":"2022-10-13T02:34:21Z",
"userID":"afb8195dd8e52cf873734dfb679de001",
"regionID":"73f321ea-62ff-11ec-a8bc-005056898fe0",
"permissionGroupID":"permission_group_zv8j0ox7a2s9fv0k",
"userPermission":"no_root_squash",
"authAddr":"10.151.11.11/24",
"permissionRuleIsDefault":false,
"permissionRuleFuid":"3d69c5b8-699a-53c4-bd85-d70e93a658eb",
"permissionGroupFuid":"00fa1424-ba4c-5f9b-be30-65014dc21ab5",
"permissionRulePriority":1,
"permissionRuleID":"permission_rule_c0sn0o99bbxgt9b5"
}
],
"pageSize":10,
"pageNo":1
},
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
