DescribeAccessRules -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


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

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	1	The total number of rules.
RequestId	String	86D89E82-4297-4343-8E1E-A2495B35****	The ID of the request.
PageSize	Integer	1	The number of entries returned per page.
PageNumber	Integer	1	The page number of the returned page.
AccessRules	Array of AccessRule		The list of rules in the permission group.
AccessRule
AccessRuleId	String	1	The ID of the rule.
SourceCidrIp	String	10.0../**	The IP address or CIDR block of the authorized object.
Ipv6SourceCidrIp	String	2001:250:6000::***	The IPv6 address or CIDR block of the authorized object.
RWAccess	String	RDWR	Grants access permissions on the file system to the authorized object. Valid values: RDWR (default value): the read and write permissions RDONLY: the read-only permissions
UserAccess	String	no_squash	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.
Priority	Integer	1	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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAccessRules
&AccessGroupName=classic-test
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAccessRulesResponse>
    <TotalCount>1</TotalCount>
    <PageSize>1</PageSize>
    <RequestId>86D89E82-4297-4343-8E1E-A2495B35****</RequestId>
    <PageNumber>1</PageNumber>
    <AccessRules>
        <AccessRule>
            <RWAccess>RDWR</RWAccess>
            <UserAccess>no_squash</UserAccess>
            <Priority>1</Priority>
            <SourceCidrIp>10.0.*.*/**</SourceCidrIp>
            <Ipv6SourceCidrIp>2001:250:6000::***</Ipv6SourceCidrIp>
            <AccessRuleId>1</AccessRuleId>
        </AccessRule>
    </AccessRules>
</DescribeAccessRulesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.