文档

DescribeAccessPoints - 查询接入点信息

查询接入点信息。

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:DescribeAccessPointsList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
FileSystemIdstring

文件系统 ID。

174494****
AccessGroupstring

权限组名称。

当目标文件系统为通用型 NAS,此参数必填。

默认权限组:DEFAULT_VPC_GROUP_NAME(专有网络默认权限组)。

DEFAULT_VPC_GROUP_NAME
MaxResultsinteger

每次查询结果的个数。

取值范围:10~100。默认值:10。

10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

6299428C-3861-435D-AE54-9B330A00****
AccessPointsobject []

接入点信息。

ARNstring

接入点 ARN。

acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****
AccessGroupstring

权限组名称。

test
AccessPointIdstring

接入点 ID。

ap-ie15yd****
AccessPointNamestring

接入点名称。

test
CreateTimestring

接入点的创建时间。

1709619668276167
DomainNamestring

接入点域名名称。

ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com
EnabledRamboolean

是否启用 RAM 策略。

false
FileSystemIdstring

文件系统 ID。

31a8e4****
ModifyTimestring

接入点的修改时间 。

1709619668276167
PosixUserobject

Posix 用户。

PosixGroupIdinteger

Posix 用户组 ID。

12
PosixUserIdinteger

Posix 用户 ID。

123
PosixSecondaryGroupIdsarray

第二用户组 ID。

integer

第二用户组 ID。

[123,123]
RootPathstring

根目录。

/
RootPathPermissionobject

根目录权限。

OwnerGroupIdlong

属主用户组 ID。

12
OwnerUserIdlong

属主用户 ID。

1
Permissionstring

POSIX 权限。

0755
RootPathStatusstring

当前根目录状态。

包括:

  • 0:rootpath 状态未知
  • 1:rootpath 不存在(可能被用户删除了)
  • 2:rootpath 状态正常
2
Statusstring

当前接入点状态。

包括:

  • Active:可用
  • Inactive:不可用
  • Pending:创建中
  • Deleting:删除中
说明 当状态为 Active 时才可以挂载文件系统。
Active
VSwitchIdstring

交换机 ID。

vsw-2zevmwkwyztjuoffg****
VpcIdstring

专有网络 ID。

vpc-2zesj9afh3y518k9o****
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****
TotalCountinteger

接入点总个数。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "6299428C-3861-435D-AE54-9B330A00****",
  "AccessPoints": [
    {
      "ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
      "AccessGroup": "test",
      "AccessPointId": "ap-ie15yd****\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"
    }
  ],
  "NextToken": "MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****\n",
  "TotalCount": 20
}

错误码

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

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