Queries the information of rules.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAccessRules

The operation that you want to perform.

Set the value to DescribeAccessRules.
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 page 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: the default value, which indicates General-purpose NAS file systems.
  • extreme: Extreme NAS file systems.

Response parameters

Parameter Type Example Description
AccessRules Array of AccessRule

The list of rules in the permission group.
AccessRule
AccessRuleId String 1

The ID of the rule.
Ipv6SourceCidrIp String 2001:250:6000::***

The IPv6 address or IPv6 CIDR block of the authorized object.
Priority Integer 1

The priority of the rule.

The rule with the highest priority takes effect if multiple rules are attached to the same authorized object.

Valid values: 1 to 100. The value 1 indicates the highest priority.
RWAccess String RDWR

Grants access permissions on the file system to the authorized object.

Valid values:

  • RDWR: the default value, which indicates the read and write permissions.
  • RDONLY: the read-only permissions.
SourceCidrIp String 10.0.*. */**

The IP address or CIDR block of the authorized object.
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.

PageNumber Integer 1

The page number of the returned page.
PageSize Integer 1

The number of entries returned per page.
RequestId String 86D89E82-4297-4343-8E1E-A2495B35****

The ID of the request.
TotalCount Integer 1

The total number of rules.

Examples

Sample requests

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

Sample success responses

XML format 

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

JSON format 

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

Error codes

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