DescribeAccessRules
Description
call DescribeAccessRules interface to query permission rule description.
Request Method
POST
Request Path
/apsara/route/NAS/DescribeAccessRules
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
PageSize | BODY | integer | No | 1 | the number of file systems contained in each paging query. value range: 1~100 default value: 10 |
PageNumber | BODY | integer | No | 1 | the paging page number of the file system list. starting value (default):1 |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
AccessGroupName | BODY | string | Yes | classic-test | permission group name. |
FileSystemType | BODY | string | No | standard | file system type. default value: standard (general purpose NAS) |
AccessRuleId | BODY | string | No | 1 | rule serial number. |
version | BODY | string | No | 2016-01-01 | version of api |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
RWAccess | string | RDWR | Authorize the read and write permissions of the object to the file system. Includes: RDWR (default): read and write RDONLY: read-only |
TotalCount | integer | 1 | the total number of permission rules. |
PageSize | integer | 1 | the number of permission rules contained in each page. |
RequestId | string | 86D89E82-4297-4343-8E1E-A2495B35CC70 | request ID. |
UserAccess | string | no_squash | user permission types: no_squash (default), root_squash and all_squash |
PageNumber | integer | 1 | the paging page number of the file system list. |
Priority | integer | 1 | priority. when the same authorization object matches multiple rules, the high priority rule takes effect. value range: 1~100,1 is the highest priority. |
SourceCidrIp | string | 10.0.*.*/** | address or address segment. |
AccessRules | array of accessrule | No sample value for this parameter. | permission rule description information set. |
AccessRuleId | string | 1 | permission rule ID. |
AccessRule | No 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
}
}