All Products
Search
Document Center

File Storage NAS:DescribeSmbAcl

Last Updated:Dec 11, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
nas:DescribeSmbAclget
*FileSystem
acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

31a8e4****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

98696EF0-1607-4E9D-B01D-F20930B6****
Aclobject

The information about the ACL feature.

EnableAnonymousAccessboolean

Indicates whether the file system allows anonymous access. Valid values:

  • true: The file system allows anonymous access.
  • false: The file system does not allow anonymous access.
true
Enabledboolean

Indicates whether the ACL feature is enabled. Valid values:

  • true: The ACL feature is enabled.
  • false: The ACL feature is disabled.
true
EncryptDataboolean

Indicates whether encryption in transit is enabled. Valid values:

  • true: Encryption in transit is enabled.
  • false: Encryption in transit is disabled.
true
RejectUnencryptedAccessboolean

Indicates whether the file system denies access from non-encrypted clients. Valid values:

  • true: The file system denies access from non-encrypted clients.
  • false: The file system allows access from non-encrypted clients.
true
SuperAdminSidstring

The ID of a super admin.

S-1-0-0
HomeDirPathstring

The home directory of each user.

/home

Examples

Sample success responses

JSONformat

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "Acl": {
    "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 Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-05API Description UpdateView Change Details
2022-08-05The response structure of the API has changedView Change Details