All Products
Search
Document Center

:List of operations by function

Last Updated:Aug 26, 2024

The following table lists the API operations that are available for use in Apsara File Storage NAS.

Category

Operation

Description

Service activation

OpenNASService

Activates Apsara File Storage NAS.

Region

DescribeRegions

Queries all region IDs.

DescribeZones

Queries all zones in a region and file system types that are supported in each zone.

File system

CreateFileSystem

Creates a file system.

DeleteFileSystem

Deletes a file system.

DescribeFileSystems

Queries the information of file systems.

ModifyFileSystem

Modifies the description of a file system.

UpgradeFileSystem

Scales up a file system.

Mount target

CreateMountTarget

Creates a mount target.

DeleteMountTarget

Deletes a mount target.

DescribeMountTargets

Queries the information of mount targets.

ModifyMountTarget

Modifies a mount target.

DescribeMountedClients

Queries the clients on which file systems are mounted.

Permission group

CreateAccessGroup

Creates a permission group.

DeleteAccessGroup

Deletes a permission group.

DescribeAccessGroups

Queries the information of permission groups.

ModifyAccessGroup

Modifies a permission group.

CreateAccessRule

Creates a rule for a permission group.

DeleteAccessRule

Deletes a rule from a permission group.

DescribeAccessRules

Queries the information of rules.

ModifyAccessRule

Modifies a rule in a permission group.

SMB AD ACL

EnableSmbAcl

Enables the access control list (ACL) feature for a Server Message Block (SMB) file system that resides in an Active Directory (AD) domain.

DisableSmbAcl

Disables the ACL feature for an SMB file system that resides in an AD domain.

ModifySmbAcl

Updates the information about the ACL feature for an SMB file system that resides in an AD domain.

DescribeSmbAcl

Queries the information about the ACL feature for an SMB file system that resides in an AD domain.

NAS NFS ACL

EnableNfsAcl

Enables the ACL feature for a General-purpose NFS file system.

DisableNfsAcl

Disables the ACL feature for a General-purpose NFS file system.

DescribeNfsAcl

Queries whether the ACL feature is enabled for a General-purpose NFS file system.

Extreme NAS snapshot

CreateSnapshot

Creates a snapshot.

CreateAutoSnapshotPolicy

Creates an automatic snapshot policy.

ApplyAutoSnapshotPolicy

Applies an automatic snapshot policy to one or more file systems.

DeleteSnapshot

Deletes a specified snapshot.

CancelAutoSnapshotPolicy

Removes automatic snapshot policies from one or more file systems.

DeleteAutoSnapshotPolicy

Deletes an automatic snapshot policy.

DescribeSnapshots

Queries all snapshots of a file system.

DescribeAutoSnapshotPolicies

Queries the details of automatic snapshot policies.

ModifyAutoSnapshotPolicy

Modifies an automatic snapshot policy.

DescribeAutoSnapshotTasks

Queries the details of automatic snapshot tasks.

ResetFileSystem

Rolls back a file system from a snapshot.

Quota

SetDirQuota

Creates a directory quota for a file system.

DescribeDirQuotas

Queries the directory quotas of a file system.

CancelDirQuota

Cancels the directory quotas of a file system.

Lifecycle management

CreateLifecyclePolicy

Creates a lifecycle policy.

DescribeLifecyclePolicies

Queries lifecycle policies.

DeleteLifecyclePolicy

Deletes a lifecycle policy.

ModifyLifecyclePolicy

Modifies a lifecycle policy.

CreateLifecycleRetrieveJob

Creates a data retrieval task.

ListLifecycleRetrieveJobs

Queries data retrieval tasks.

ListDirectoriesAndFiles

Queries the subdirectories or files in a specified directory of a General-purpose NAS file system.

GetDirectoryOrFileProperties

Queries whether a specified directory contains files stored in an IA storage medium or whether a specified file is stored in an IA storage medium.

CancelLifecycleRetrieveJob

Cancels a data retrieval task that is in the Running state.

RetryLifecycleRetrieveJob

Runs a data retrieval task that is in the Failed state.

Recycle bin

EnableRecycleBin

Enables the recycle bin feature for a General-purpose NAS file system.

DisableAndCleanRecycleBin

Disables the recycle bin feature for a General-purpose NAS file system and empties the recycle bin.

UpdateRecycleBinAttribute

Modifies the data retention period for the recycle bin of a specified General-purpose NAS file system.

GetRecycleBinAttribute

Queries the configurations of the recycle bin of a specified General-purpose NAS file system.

CreateRecycleBinRestoreJob

Retrieves files from the recycle bin.

CreateRecycleBinDeleteJob

Permanently deletes files or directories from the recycle bin.

CancelRecycleBinJob

Cancels a running task of the recycle bin.

ListRecycleBinJobs

Queries tasks of the recycle bin.

ListRecycledDirectoriesAndFiles

Queries deleted files or directories.

ListRecentlyRecycledDirectories

Queries the directories from which files are recently deleted.

Log management

CreateLogAnalysis

Dumps the logs of a General-purpose NAS file system to Log Service.

DeleteLogAnalysis

Disables log dumping for a General-purpose NAS file system.

DescribeLogAnalysis

Queries the log dump information configured in log analysis.

For more information, visit API Resource Center, OpenAPI Explorer, and API Error Center.