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

文档中心

立即注册

导航

DescribePermissionGroups

最近更新时间：2025.03.07 18:24:25首次发布时间：2023.07.10 11:11:52

调用 DescribePermissionGroups 接口列举权限组。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribePermissionGroups	要执行的操作，取值：DescribePermissionGroups。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
PageSize	Integer	否	10	分页查询时设置的每页行数。
PageNumber	Integer	否	1	分页页码。
FileSystemType	String	是	Extreme	文件系统类型。取值说明如下： `Extreme`：NAS 极速型。 `Capacity`：NAS 容量型。 `Cache`：NAS 缓存型。
Filters	Array of Object	否	详情请参见请求示例	筛选指定特征的权限组。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

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

请求示例

POST /?Action=DescribePermissionGroups&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: open.volcengineapi.com
X-Date: 20180614T114308Z
Authorization: HMAC-SHA256 Credential=AK*********************/20210328/cn-beijing/filenas/request, SignedHeaders=x-date, Signature=*********************
{
    "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
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
404	InvalIdRegionId.NotFound	The specified parameter RegionId is invalid.	指定区域不存在
500	InternalError	An internal error has occurred.	内部错误。