DescribeAccessGroups-阿里云帮助中心

Queries permission group information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:DescribeAccessGroups

list

*AccessGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
AccessGroupName	string	No	The name of the permission group. Limits: The name must be 3 to 64 characters in length. The name must start with a letter and can contain letters, digits, underscores (_), or hyphens (-).	DEFAULT_VPC_GROUP_NAME
PageSize	integer	No	The number of permission groups on each page. Valid values: 1 to 100. Default value: 10.	2
PageNumber	integer	No	The page number of the list. Start value (default value): 1.	1
UseUTCDateTime	boolean	No	Specifies whether the returned time is displayed in UTC. Valid values: true (default): The returned time is displayed in UTC. false: The returned time is not displayed in UTC.	true
FileSystemType	string	No	The type of the file system. Valid values: standard (default): General-purpose NAS. extreme: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS). Valid values: standard : General-purpose NAS. cpfs : Cloud Paralleled File System. extreme : Extreme NAS.	standard

Response elements

Element	Type	Description	Example
	object
AccessGroups	object
AccessGroup	array<object>	The collection of permission group information.
	object
AccessGroupName	string	The name of the permission group.	DEFAULT_VPC_GROUP_NAME
Description	string	The description of the permission group.	This is a test access group.
CreateTime	string	The time when the permission group was created. The time follows the ISO 8601 standard and is returned in the yyyy-MM-ddTHH:mm:ssZ format.	2020-01-05T16:00:00Z
AccessGroupType	string	The type of the permission group. The value Vpc indicates a virtual private cloud (VPC).	Vpc
RuleCount	integer	The number of permission rules in the permission group.	0
MountTargetCount	integer	The number of mount targets to which the permission group is applied.	0
FileSystemType	string	The file system type. Valid values: standard (default): General-purpose NAS. extreme: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS).	standard
RegionId	string	The region ID.	cn-hangzhou
TotalCount	integer	The total number of permission groups.	1
RequestId	string	The request ID.	2514F97E-FFF0-4A1F-BF04-729CEAC6****
PageSize	integer	The number of permission groups on each page.	2
PageNumber	integer	The page number of the list.	1

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.