All Products
Search
Document Center

Apsara File Storage NAS:DescribeAccessRules

Last Updated:Mar 14, 2024

Queries the information about rules in a permission group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AccessGroupNamestringYes

The name of the permission group.

vpc-test
AccessRuleIdstringNo

The ID of the rule.

1
PageSizeintegerNo

The number of entries per page.

Valid values: 1 to 100.

Default value: 10.

1
PageNumberintegerNo

The page number.

Pages start from page 1. Default value: 1.

1
FileSystemTypestringNo

The type of the file system.

Valid values:

  • standard (default): General-purpose NAS file system
  • extreme: Extreme NAS file system
standard

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of rules.

1
RequestIdstring

The request ID.

86D89E82-4297-4343-8E1E-A2495B35****
PageSizeinteger

The number of entries per page.

1
PageNumberinteger

The page number.

1
AccessRulesobject []

The rules in the permission group.

AccessRuleIdstring

The ID of the rule.

1
SourceCidrIpstring

The IP address or CIDR block of the authorized object.

10.0.*.*/**
Ipv6SourceCidrIpstring

The IPv6 address or CIDR block of the authorized object.

2001:250:6000::***
RWAccessstring

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
UserAccessstring

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
Priorityinteger

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

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
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-02-26The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.