Query access rules in a permission group with DescribeAccessRules - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries the description of a permission rule.

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:DescribeAccessRules

list

*AccessGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
AccessGroupName	string	Yes	The name of the permission group.	classic-test
AccessRuleId	string	No	The ID of the permission rule.	1
PageSize	integer	No	The number of file systems on each page during a paged query. Valid values: 1 to 100. Default value: 10.	1
PageNumber	integer	No	The page number of the file system list. Start value (default value): 1.	1
FileSystemType	string	No	The type of the file system. Valid values: standard (default): General-purpose NAS. extreme: Extreme NAS. Valid values: standard : Extreme NAS. extreme : General-purpose NAS.	standard

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of permission rules.	1
RequestId	string	The request ID.	86D89E82-4297-4343-8E1E-A2495B35****
PageSize	integer	The number of permission rules on each page.	1
PageNumber	integer	The page number of the file system list.	1
AccessRules	object
AccessRule	array<object>	The collection of permission rule information.
	object
AccessRuleId	string	The ID of the rule.	1
SourceCidrIp	string	The IP address or CIDR block of the authorized object.	10.0../**
Ipv6SourceCidrIp	string	The IPv6 address or CIDR block of the authorized object.	2001:250:6000::***
RWAccess	string	The access permissions of the authorized object on the file system. Valid values: RDWR (default): the read and write permissions. RDONLY: the read-only permission.	RDWR
UserAccess	string	The access permissions for different types of users in the authorized object. Valid values: no_squash: allows access from root users to the file system. root_squash: grants root users the least permissions as the nobody user. all_squash: grants all users the least permissions as the nobody user. The nobody user has the least permissions in Linux and can access only the public content of the file system. This ensures the security of the file system.	no_squash
Priority	integer	The priority of the rule. If multiple rules are attached to the authorized object, the rule with the highest priority takes effect. Valid values: 1 to 100. The value 1 indicates the highest priority.	1
FileSystemType	string	The type of the file system. Valid values: standard: General-purpose Apsara File Storage NAS (NAS) file system. extreme: Extreme NAS file system.	standard
AccessGroupName	string	The name of the permission group.	test
RegionId	string	The region ID.	cn-hangzhou

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "86D89E82-4297-4343-8E1E-A2495B35****",
  "PageSize": 1,
  "PageNumber": 1,
  "AccessRules": {
    "AccessRule": [
      {
        "AccessRuleId": "1",
        "SourceCidrIp": "10.0.*.*/**",
        "Ipv6SourceCidrIp": "2001:250:6000::***",
        "RWAccess": "RDWR",
        "UserAccess": "no_squash",
        "Priority": 1,
        "FileSystemType": "standard",
        "AccessGroupName": "test",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.