DescribePermissionGroups--文件存储 NAS-火山引擎

文档中心

导航

DescribePermissionGroups

最近更新时间：2024.06.20 19:04:18首次发布时间：2023.07.10 11:11:52

调用 DescribePermissionGroups 接口查看权限组信息。

请求参数

参数	类型	是否必选	示例值	描述
FileSystemType	String	是	Extreme	文件系统类型。取值说明如下： `Extreme`：NAS 极速型。 `Capacity`：NAS 容量型。
PageSize	Integer	否	10	文件系统列表的分页页码。
PageNumber	Integer	否	1	每个分页包含的文件系统个数。
Filters	Array of PermissionGroupFilter	否	详情请参见请求示例	筛选指定特征的权限组。

PermissionGroupFilter

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Key	String	是	PermissionGroupName	根据特性筛选指定特征的权限组。支持筛选的参数如下： `PermissionGroupName`：根据权限组名称模糊筛选，不支持多选。 `PermissionGroupId`：根据权限组 ID 精确筛选，不支持多选。
Value	String	是	test	筛选项目的值。

Key

String

是

PermissionGroupName

根据特性筛选指定特征的权限组。支持筛选的参数如下：

PermissionGroupName：根据权限组名称模糊筛选，不支持多选。
PermissionGroupId：根据权限组 ID 精确筛选，不支持多选。

Value String 是 test 筛选项目的值。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	1	权限组个数。
PageSize	Integer	10	文件系统列表的分页页码。
PageNumber	Integer	1	每个分页包含的文件系统个数。
PermissionGroups	Array of PermissionGroup	详情请参见返回示例	权限组信息，不包含有效权限规则信息。

PermissionGroup

参数	类型	示例值	描述
CreateTime	String	2022-05-26T20:09:00+08:00	权限组创建时间。
Description	String	test	权限组描述信息。
MountPoints	Array of BasicMountPoint	详情请参见返回示例	使用该权限组的挂载点信息。
FileSystemType	String	Extreme	文件系统类型。取值说明如下： `Extreme`：NAS 极速型。 `Capacity`：NAS 容量型。
FileSystemCount	Integer	1	关联该权限组的文件系统数量。
PermissionGroupId	String	test	权限组 ID。
PermissionGroupName	String	test	权限组名称。
PermissionRuleCount	Integer	1	权限规则数量。

BasicMountPoint

参数	类型	示例值	描述
FileSystemId	String	eenas-cnbj1c789dca****	文件系统 ID。
MountPointId	String	mount-a6ee****	挂载点 ID。
MountPointName	String	MountPoint	挂载点名称。

示例

请求示例

POST /?Action=DescribePermissionGroups&Version=2022-01-01 HTTP/1.1
Host: filenas.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/filenas/request, SignedHeaders=host;x-date;x-content-sha256;content-type, Signature=7f1119a75111535b1d6e7929700f22e1474af0fb4fe26c59f5ac5cdba0cc****
Content-Type: application/json; charset=utf-8
X-Content-Sha256: 567112abe45bd6a09504fd244237f14c0ba120491da0d35097afd54d87bd****
X-Date: 20230907T124910Z
{
    "PageNumber" : 1,
    "PageSize" : 10,
    "Filters":[
        {
            "Key": "PermissionGroupName", 
            "Value": "test"
         }
     ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209081016560101742461360972C476",
        "Action": "DescribePermissionGroups",
        "Version": "2022-01-01",
        "Service": "FileNAS",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "PermissionGroups": [
            {
                "CreateTime": "2023-06-12T20:53:53+08:00",
                "Description": "测试",
                "FileSystemCount": 1,
                "FileSystemType": "Extreme",
                "MountPoints": [
                    {
                        "FileSystemId": "enas-cnbjd2b4f43b****",
                        "MountPointId": "mount-98d7****",
                        "MountPointName": "test"
                    }
                ],
                "PermissionGroupId": "pgroup-77afc370****",
                "PermissionGroupName": "PGgroup",
                "PermissionRuleCount": 1
            }
        ],
        "TotalCount": 1
    }
}