Query mount targets by using DescribeMountTargets - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries mount target information.

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:DescribeMountTargets

get

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID. General-purpose NAS: 31a8e4**. Extreme NAS: must start with `extreme-`, for example, extreme-0015. Cloud Parallel File Storage (CPFS): must start with `cpfs-`, for example, cpfs-125487**.	1ca404****
MountTargetDomain	string	No	The mount target address.	1ca404**-x**.cn-hangzhou.nas.aliyuncs.com
PageSize	integer	No	The number of mount targets on each page. Valid values: 1 to 100. Default value: 10.	1
PageNumber	integer	No	The page number of the list. Start value (default value): 1.	1
DualStackMountTargetDomain	string	No	The dual-stack (IPv4 and IPv6) mount target domain. Note Currently, IPv6 is supported only by Extreme NAS file systems in regions in the Chinese mainland.	1ca404**-x**.dualstack.cn-hangzhou.nas.aliyuncs.com

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of mount targets.	1
RequestId	string	The request ID.	3BAB90FD-B4A0-48DA-9F09-2B963510****
PageSize	integer	The number of mount targets on each page when paging is used.	1
PageNumber	integer	The page number of the file system list.	1
MountTargets	object
MountTarget	array<object>	The collection of mount target information.
	array<object>
VpcId	string	The ID of the VPC.	vpc-2zesj9afh3y518k9o****
Status	string	The status of the mount target. Valid values: Active: The mount target is available. Inactive: The mount target is unavailable. Pending: The mount target is being created. Deleting: The mount target is being deleted. Hibernating: The mount target is hibernating. Hibernated: The mount target is hibernated. Note You can mount a file system only when the mount target is Active.	Active
ClientMasterNodes	object	A collection of client management nodes.
ClientMasterNode	array<object>	A list of client management nodes.
	object
EcsId	string	The ID of the ECS instance that serves as a management node.	i-hp3i3odi5ory1buo****
DefaultPasswd	string	The default login password.	12****
EcsIp	string	The IP address of the ECS instance that serves as a management node.	192.168.1.0
MountTargetDomain	string	The domain name of the IPv4 mount target.	1ca404**-w**.cn-hangzhou.nas.aliyuncs.com
AccessGroup	string	The name of the permission group for the mount target.	DEFAULT_VPC_GROUP_NAME
DualStackMountTargetDomain	string	The domain name of the dual-stack mount target.	1ca404**-x**.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	The ID of the VSwitch.	vsw-2zevmwkwyztjuoffg****
Tags	object
Tag	array<object>	A list of tags attached to the mount target. A mount target can have up to 20 tags, and each tag key must be unique.
	object	The tag.
Key	string	The tag key. A tag key cannot be an empty string. The tag key can be up to 128 characters long. The tag key cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	nastest
Value	string	The tag value. Restrictions: The tag value can be up to 128 characters long. The tag value cannot contain `http://` or `https://`.	mounttargettest
NetworkType	string	The network type of the mount target. The value is always Vpc.	Vpc
IPVersion	string	The IP version supported by the mount target. IPv4: The mount target supports only IPv4. DualStack: The mount target supports both IPv4 and IPv6.	IPv4
AccessPointAccessOnly	boolean	Indicates whether the file system can be accessed only by using an access point. `true`: The file system can be accessed only by using an access point. `false`: The file system can be accessed by using the domain name of the mount target.	true

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "3BAB90FD-B4A0-48DA-9F09-2B963510****",
  "PageSize": 1,
  "PageNumber": 1,
  "MountTargets": {
    "MountTarget": [
      {
        "VpcId": "vpc-2zesj9afh3y518k9o****",
        "Status": "Active",
        "ClientMasterNodes": {
          "ClientMasterNode": [
            {
              "EcsId": "i-hp3i3odi5ory1buo****",
              "DefaultPasswd": "12****",
              "EcsIp": "192.168.1.0"
            }
          ]
        },
        "MountTargetDomain": "1ca404****-w****.cn-hangzhou.nas.aliyuncs.com",
        "AccessGroup": "DEFAULT_VPC_GROUP_NAME",
        "DualStackMountTargetDomain": "1ca404****-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
        "VswId": "vsw-2zevmwkwyztjuoffg****",
        "Tags": {
          "Tag": [
            {
              "Key": "nastest",
              "Value": "mounttargettest"
            }
          ]
        },
        "NetworkType": "Vpc",
        "IPVersion": "IPv4",
        "AccessPointAccessOnly": true
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFileSystem.NotsupportedIPv6	The file system does not support IPv6.	The file system does not support IPv6.
404	InvalidMountTarget.NotFound	The specified mount target does not exist.	The specified mount target does not exist.
404	InvalidFileSystem.NotFound	The specified file system 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.