DescribeAccessGroups - 查询权限组信息

更新时间:
复制 MD 格式

查询权限组信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:DescribeAccessGroups

list

*AccessGroup

acs:nas:{#regionId}:{#accountId}:accessgroup/{#accessgroupName}

请求参数

名称

类型

必填

描述

示例值

AccessGroupName

string

权限组名称。

限制:

  • 长度为 3~64 个字符。

  • 必须以大小写字母开头,可以包含英文字母、数字、下划线(_)或者短划线(-)。

DEFAULT_VPC_GROUP_NAME

PageSize

integer

每个分页包含的权限组个数。

取值范围:1~100。

默认值:10。

2

PageNumber

integer

列表的分页页码。

起始值(默认值):1。

1

UseUTCDateTime

boolean

指定返回的时间是否按照 UTC 标准格式表示。

取值:

  • true(默认值):返回的时间为 UTC 标准格式。

  • false:返回的时间为非 UTC 标准格式。

true

FileSystemType

string

文件系统类型。

取值:

  • standard(默认值):通用型 NAS。

  • extreme:极速型 NAS。

  • cpfs:CPFS。

枚举值:

  • standard :

    通用型 NAS

  • cpfs :

    文件存储 CPFS

  • extreme :

    极速型 NAS

standard

返回参数

名称

类型

描述

示例值

object

AccessGroups

object

AccessGroup

array<object>

权限组信息集合。

object

AccessGroupName

string

权限组名称。

DEFAULT_VPC_GROUP_NAME

Description

string

权限组描述信息。

This is a test access group.

CreateTime

string

权限组的创建时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ。

2020-01-05T16:00:00Z

AccessGroupType

string

权限组类型。取值为 Vpc,表示专有网络。

Vpc

RuleCount

integer

此权限组中包含的权限组规则数量。

0

MountTargetCount

integer

应用此权限组的挂载点数量。

0

FileSystemType

string

文件系统类型。

取值:

  • standard(默认值):通用型 NAS。

  • extreme:极速型 NAS。

  • cpfs:CPFS。

standard

RegionId

string

地域 ID。

cn-hangzhou

TotalCount

integer

权限组的总个数。

1

RequestId

string

请求 ID。

2514F97E-FFF0-4A1F-BF04-729CEAC6****

PageSize

integer

每个分页包含的权限组个数。

2

PageNumber

integer

列表的分页页码。

1

示例

正常返回示例

JSON格式

{
  "AccessGroups": {
    "AccessGroup": [
      {
        "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
        "Description": "This is a test access group.",
        "CreateTime": "2020-01-05T16:00:00Z",
        "AccessGroupType": "Vpc",
        "RuleCount": 0,
        "MountTargetCount": 0,
        "FileSystemType": "standard",
        "RegionId": "cn-hangzhou"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "2514F97E-FFF0-4A1F-BF04-729CEAC6****",
  "PageSize": 2,
  "PageNumber": 1
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情