DescribeAccessRules - File Storage NAS - Alibaba Cloud Documentation Center

Queries the information about rules in a permission group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nas:DescribeAccessRules	list	*AccessGroup `acs:nas:{#regionId}:{#accountId}:accessgroup/{#accessgroupName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AccessGroupName	string	Yes	The name of the permission group.	vpc-test
AccessRuleId	string	No	The rule ID.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	1
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
FileSystemType	string	No	The type of the file system. Valid values: standard (default): General-purpose NAS file system extreme: Extreme NAS file system	standard

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of rules.	1
RequestId	string	The request ID.	86D89E82-4297-4343-8E1E-A2495B35****
PageSize	integer	The number of entries per page.	1
PageNumber	integer	The page number.	1
AccessRules	array<object>	The rules in the permission group.
AccessRule	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 permissions	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 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

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-26	The response structure of the API has changed	View Change Details