文档

DescribeAccessGroups - 查询权限组信息

查询权限组信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:DescribeAccessGroupsRead
  • AccessGroup
    acs:nas:{#regionId}:{#accountId}:accessgroup/{#accessgroupName}

请求参数

名称类型必填描述示例值
AccessGroupNamestring

权限组名称。

限制:

  • 长度为 3~64 个字符。

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

DEFAULT_VPC_GROUP_NAME
PageSizeinteger

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

取值范围:1~100

默认值:10

2
PageNumberinteger

列表的分页页码。

起始值(默认值):1

1
UseUTCDateTimeboolean

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

取值:

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

文件系统类型。

取值:

  • standard(默认值):通用型 NAS
  • extreme:极速型 NAS
  • cpfs:CPFS
说明 仅中国站支持 cpfs 文件系统。
standard

返回参数

名称类型描述示例值
object
AccessGroupsobject []

权限组信息集合。

AccessGroupNamestring

权限组名称。

DEFAULT_VPC_GROUP_NAME
Descriptionstring

权限组描述信息。

This is a test access group.
CreateTimestring

权限组的创建时间。

2020-01-05T16:00:00Z
AccessGroupTypestring

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

Vpc
RuleCountinteger

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

0
MountTargetCountinteger

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

0
TotalCountinteger

权限组的总个数。

1
RequestIdstring

请求 ID。

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

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

2
PageNumberinteger

列表的分页页码。

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": "",
        "RegionId": ""
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "2514F97E-FFF0-4A1F-BF04-729CEAC6****",
  "PageSize": 2,
  "PageNumber": 1
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-11-03OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
  • 本页导读 (1)
文档反馈