DescribeMountTargets - File Storage NAS - Alibaba Cloud Documentation Center

Queries mount targets.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
nas:DescribeMountTargets	get	*FileSystem `acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system. Sample ID of a General-purpose NAS file system: 31a8e4**. The IDs of Extreme NAS file systems must start with `extreme-`, for example, extreme-0015. The IDs of Cloud Parallel File Storage (CPFS) file systems must start with `cpfs-`, for example, cpfs-125487. Note** CPFS file systems are available only on the China site (aliyun.com).	1ca404****
MountTargetDomain	string	No	The domain name of the mount target.	1ca404a666-x****.cn-hangzhou.nas.aliyuncs.com
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	1
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
DualStackMountTargetDomain	string	No	The dual-stack (IPv4 and IPv6) domain name of the mount target. Note Only Extreme NAS file systems that reside in the Chinese mainland support IPv6.	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com

Response parameters

Parameter	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 entries per page.	1
PageNumber	integer	The page number.	1
MountTargets	array<object>	The information about mount targets.
MountTarget	object
VpcId	string	The ID of the virtual private cloud (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 or modified. Deleting: The mount target is being deleted. Hibernating: The mount target is being hibernated. Hibernated: The mount target is hibernated. Note You can mount a file system only when the mount target of the file system is in the Active state.	Active
ClientMasterNodes	array<object>	The information about client management nodes.
ClientMasterNode	object
EcsId	string	The ID of the ECS instance on the client management node.	i-hp3i3odi5ory1buo****
DefaultPasswd	string	The default logon password of the ECS instance.	12****
EcsIp	string	The IP address of the ECS instance on the client management node.	192.168.1.0
MountTargetDomain	string	The IPv4 domain name of the mount target.	1ca404a666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroup	string	The name of the permission group that is attached to the mount target.	DEFAULT_VPC_GROUP_NAME
DualStackMountTargetDomain	string	The dual-stack (IPv4 and IPv6) domain name of the mount target.	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	The ID of the vSwitch.	vsw-2zevmwkwyztjuoffg****
NetworkType	string	The network type. Valid value: Vpc.	Vpc
IPVersion	string	The type of the mount target. IPv4: an IPv4 mount target DualStack: a dual-stack mount target	IPv4

Examples

Sample success responses

JSONformat

{
  "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": "1ca404a666-w****.cn-hangzhou.nas.aliyuncs.com",
        "AccessGroup": "DEFAULT_VPC_GROUP_NAME",
        "DualStackMountTargetDomain": "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
        "VswId": "vsw-2zevmwkwyztjuoffg****",
        "NetworkType": "Vpc",
        "IPVersion": "IPv4"
      }
    ]
  }
}

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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-04	The Error code has changed	View Change Details
2023-04-17	The Error code has changed	View Change Details