调用DescribeAccessPoints查询接入点信息-文件存储NAS-阿里云-文件存储NAS(NAS)-阿里云帮助中心

查询接入点信息。

说明

目前该API接口已标记为弃用，推荐使用替代API：NAS(2017-06-26) - ListAccessPoints。

接口说明

仅通用型 NAS NFS 协议文件系统支持该功能。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:DescribeAccessPoints

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
FileSystemId	string	否	文件系统 ID。	174494****
AccessGroup	string	否	权限组名称。当目标文件系统为通用型 NAS，此参数必填。默认权限组：DEFAULT_VPC_GROUP_NAME（专有网络默认权限组）。	DEFAULT_VPC_GROUP_NAME
MaxResults	integer	否	每次查询结果的个数。取值范围：10~100。默认值：10。	10
Tag	array<object>	否	接入点标签列表。
	object	否	接入点标签列表。
Key	string	否	标签键。限制： N 的取值范围为 1~20。最多支持 128 个字符。不能以 aliyun 或 acs:开头。不能包含 http://和 https://。	TestKey
Value	string	否	标签值。限制： N 的取值范围为 1~20。最多支持 128 个字符。不能以 aliyun 或 acs:开头。不能包含 http://和 https://。	TestValue
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	6299428C-3861-435D-AE54-9B330A00****
AccessPoints	array<object>	接入点信息。
	array<object>
ARN	string	接入点 ARN。	acs:nas:cn-hangzhou:178321033379**:accesspoint/ap-ie15yd**
AccessGroup	string	权限组名称。	test
AccessPointId	string	接入点 ID。	ap-ie15y*****
AccessPointName	string	接入点名称。	test
CreateTime	string	接入点的创建时间。	1709619668276167
DomainName	string	接入点域名名称。	ap-ie15ydanoz.001014**-w**.cn-hangzhou.nas.aliyuncs.com
EnabledRam	boolean	是否启用 RAM 策略。	false
FileSystemId	string	文件系统 ID。	31a8e4****
ModifyTime	string	接入点的修改时间。	1709619668276167
PosixUser	object	Posix 用户。
PosixGroupId	integer	Posix 用户组 ID。	12
PosixUserId	integer	Posix 用户 ID。	123
PosixSecondaryGroupIds	array	第二用户组 ID。
	integer	第二用户组 ID。	[123,123]
RootPath	string	根目录。	/
RootPathPermission	object	根目录权限。
OwnerGroupId	integer	属主用户组 ID。	12
OwnerUserId	integer	属主用户 ID。	1
Permission	string	POSIX 权限。	0755
RootPathStatus	string	当前根目录状态。包括： 0：rootpath 状态未知 1：rootpath 不存在（可能被用户删除了） 2：rootpath 状态正常	2
Status	string	当前接入点状态。包括： Active：可用 Inactive：不可用 Pending：创建中 Deleting：删除中说明当状态为 Active 时才可以挂载文件系统。	Active
VSwitchId	string	交换机 ID。	vsw-2zevmwkwyztjuoffg****
VpcId	string	专有网络 ID。	vpc-2zesj9afh3y518k9o****
Tags	array<object>	接入点标签列表。
	object	接入点标签列表。
Key	string	标签键。	TestKey
Value	string	标签值。	TestValue
NextToken	string	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****
TotalCount	integer	接入点总个数。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "6299428C-3861-435D-AE54-9B330A00****",
  "AccessPoints": [
    {
      "ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
      "AccessGroup": "test",
      "AccessPointId": "ap-ie15y*****\n",
      "AccessPointName": "test",
      "CreateTime": "1709619668276167",
      "DomainName": "ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com",
      "EnabledRam": false,
      "FileSystemId": "31a8e4****\n",
      "ModifyTime": "1709619668276167",
      "PosixUser": {
        "PosixGroupId": 12,
        "PosixUserId": 123,
        "PosixSecondaryGroupIds": [
          0
        ]
      },
      "RootPath": "/",
      "RootPathPermission": {
        "OwnerGroupId": 12,
        "OwnerUserId": 1,
        "Permission": "0755"
      },
      "RootPathStatus": "2",
      "Status": "Active",
      "VSwitchId": "vsw-2zevmwkwyztjuoffg****\n",
      "VpcId": "vpc-2zesj9afh3y518k9o****\n",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ],
  "NextToken": "MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****\n",
  "TotalCount": 20
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidFilesystemType.NotSupport	The API operation does not support the file system type.	当前接口不支持该类型文件系统。
403	InvalidProtocolType.NotSupported	The specified protocol type does not supported.	指定的协议类型不支持。
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的文件系统不存在。
404	InvalidAccessGroup.NotFound	The specified AccessGroup does not exist.	您指定的权限组不存在或已删除。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。