Queries the information about the access control list (ACL) feature of a Server Message Block (SMB) file system that resides in an Active Directory (AD) domain.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | DescribeSmbAcl |
The operation that you want to perform. Set the value to DescribeSmbAcl. |
| FileSystemId | String | Yes | 31a8e4**** |
The ID of the file system. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | 98696EF0-1607-4E9D-B01D-F20930B6**** |
The ID of the request. |
| Acl | Object |
The information about the ACL feature. |
|
| AuthMethod | String | Kerberos |
The method that is used to authenticate network identities. |
| EnableAnonymousAccess | Boolean | true |
Specifies whether to allow anonymous access. Valid values:
|
| Enabled | Boolean | true |
Specifies whether to enable the ACL feature.
|
| EncryptData | Boolean | true |
Specifies whether to enable encryption in transit.
|
| RejectUnencryptedAccess | Boolean | true |
Specifies whether to deny access from non-encrypted clients.
|
| SuperAdminSid | String | S-1-0-0 |
The ID of a super admin. |
| HomeDirPath | String | /home |
The home directory of each user. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeSmbAcl
&FileSystemId=31a8e4****
&Common request parameters
Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeSmbAclResponse>
<RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>
<Acl>
<AuthMethod>Kerberos</AuthMethod>
<EnableAnonymousAccess>true</EnableAnonymousAccess>
<Enabled>true</Enabled>
<EncryptData>true</EncryptData>
<RejectUnencryptedAccess>true</RejectUnencryptedAccess>
<SuperAdminSid>S-1-0-0</SuperAdminSid>
<HomeDirPath>/home</HomeDirPath>
</Acl>
</DescribeSmbAclResponse>
JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "98696EF0-1607-4E9D-B01D-F20930B6****",
"Acl" : {
"AuthMethod" : "Kerberos",
"EnableAnonymousAccess" : true,
"Enabled" : true,
"EncryptData" : true,
"RejectUnencryptedAccess" : true,
"SuperAdminSid" : "S-1-0-0",
"HomeDirPath" : "/home"
}
}
Error codes
For a list of error codes, visit the API Error Center.