Query SMB ACL information using DescribeSmbAcl - File Storage NAS - Alibaba Cloud - File Storage NAS

Operation description

Before you begin: Before calling this API, ensure that the KMS service is activated in the target region. You can activate it by calling the Kms.OpenKmsService API or through the console. This restriction also applies to unencrypted file systems with EncryptType=0.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:DescribeSmbAcl

get

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	31a8e4****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
Acl	object	The ACL information.
EnableAnonymousAccess	boolean	Indicates whether anonymous access is allowed. Valid values: true: Anonymous access is allowed. false: Anonymous access is not allowed.	true
Enabled	boolean	Indicates whether the SMB AD ACL feature is enabled. true: The SMB AD ACL feature is enabled. false: The SMB AD ACL feature is not enabled.	true
EncryptData	boolean	Indicates whether encryption in transit is enabled. true: Encryption in transit is enabled. false: Encryption in transit is not enabled.	true
RejectUnencryptedAccess	boolean	Indicates whether unencrypted clients are rejected. true: Unencrypted clients are rejected. false: Unencrypted clients are not rejected.	true
SuperAdminSid	string	The ID of the superuser.	S-1-0-0
HomeDirPath	string	The home directory path for each user.	/home

Examples

Success response

JSON format

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "Acl": {
    "EnableAnonymousAccess": true,
    "Enabled": true,
    "EncryptData": true,
    "RejectUnencryptedAccess": true,
    "SuperAdminSid": "S-1-0-0",
    "HomeDirPath": "/home"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.KmsServiceNotEnabled	The KMS service is not Enabled.	The KMS service is not enabled.
404	InvalidFileSystem.NotFound	The specified filesystem does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.