Skip to main content

DescribeAccessRules

Description

call DescribeAccessRules interface to query permission rule description.

Request Method

POST

Request Path

/apsara/route/NAS/DescribeAccessRules

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
PageSizeBODYintegerNo1the number of file systems contained in each paging query. value range: 1~100 default value: 10
PageNumberBODYintegerNo1the paging page number of the file system list. starting value (default):1
regionIdBODYstringYesNo sample value for this parameter.region id
AccessGroupNameBODYstringYesclassic-testpermission group name.
FileSystemTypeBODYstringNostandardfile system type. default value: standard (general purpose NAS)
AccessRuleIdBODYstringNo1rule serial number.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
RWAccessstringRDWRAuthorize the read and write permissions of the object to the file system. Includes: RDWR (default): read and write RDONLY: read-only
TotalCountinteger1the total number of permission rules.
PageSizeinteger1the number of permission rules contained in each page.
RequestIdstring86D89E82-4297-4343-8E1E-A2495B35CC70request ID.
UserAccessstringno_squashuser permission types: no_squash (default), root_squash and all_squash
PageNumberinteger1the paging page number of the file system list.
Priorityinteger1priority. when the same authorization object matches multiple rules, the high priority rule takes effect. value range: 1~100,1 is the highest priority.
SourceCidrIpstring10.0.*.*/**address or address segment.
AccessRulesarray of accessruleNo sample value for this parameter.permission rule description information set.
AccessRuleIdstring1permission rule ID.
AccessRuleNo sample value for this parameter.No description for this parameter.

Example

Successful Response example

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

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}