You need to enable JavaScript to run this app.
文档中心
弹性文件存储

弹性文件存储

复制全文
下载 pdf
接入点
DescribeAccessPoints - 列举接入点
复制全文
下载 pdf
DescribeAccessPoints - 列举接入点
调用 DescribeAccessPoints 接口列举接入点。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeAccessPoints​
要执行的操作,取值:DescribeAccessPoints。​
​
Version string 必选 示例值:2025-01-01​
API的版本,取值:2025-01-01。​
​
FileSystemId string 必选 示例值:efs-cnbjb24db2d21****​
文件系统 ID。​
​
PageSize integer 可选 示例值:10​
每个分页包含的接入点个数。​
​
PageNumber integer 可选 示例值:1​
分页页码。​
​
FileSystemPath string 可选 示例值:/path_test​
文件系统路径。​
​
AccessPointId string 可选 示例值:ap-n7db****​
接入点 ID。​
​
AccessPointName string 可选 示例值:pointname_test​
接入点名称。​
​
VpcId string 可选 示例值:vpc-30uexwepls3cw7r2qr2h2****​
私有网络 ID。​
​
ZoneId string 可选 示例值:cn-beijing-b​
可用区 ID。​
​
Language string 可选 示例值:ZH​
显示的语言类型,取值说明如下:​
  • ZH:中文​
  • EN:英文​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TotalCount integer 示例值:1​
接入点个数。​
​
PageSize integer 示例值:10​
分页个数。​
​
PageNumber integer 示例值:1​
接入点列表的分页页码。​
​
AccessPoints object[] 示例值:详情请参见示例代码​
接入点详细信息。​
AccessPointId string 示例值:ap-n7db****​
接入点 ID。​
​
AccessPointName string 示例值:test​
接入点名称。​
​
Status string 示例值:Running​
接入点状态。​
​
PermissionGroupId string 示例值:pgroup-7201****​
权限组 ID。​
​
PermissionGroupName string 示例值:test​
权限组名称。​
​
ZoneId string 示例值:cn-beijing-b​
可用区 ID。​
​
ZoneName string 示例值:China (Beijing) B​
可用区名称。​
​
VpcId string 示例值:vpc-30uexwepls3cw7r2qr2h2****​
私有网络 ID。​
​
VpcName string 示例值:vpcname_test​
私有网络名称。​
​
SubnetId string 示例值:subnet-3jhaxpk3qwrgg3pncme77****​
子网 ID。​
​
SubnetName string 示例值:subnetname_test​
子网名称。​
​
Trn string 示例值:trn:efs:cn-beijing:210015****:filesystem/efs-cnbjb24db2d21****​
接入点 TRN。​
​
Domain string 示例值:cnbjb030b2711****.3hjdtujzi2cjk3nkipjjq****.cn-beijing.efs.ivolces.com​
接入点域名。​
​
FileSystemPath string 示例值:/path_test​
文件系统路径。​
​
EnableIam boolean 示例值:true​
接入点是否开启 IAM 策略。​
  • true:开启​
  • false:关闭​
​
CreateTime string 示例值:2025-09-02T14:22:17+08:00​
接入点创建时间。​
​
UpdateTime string 示例值:2025-09-02T14:22:17+08:00​
接入点修改时间。​
​
PosixUser object 示例值:详情请参见示例代码​
POSIX 用户信息。​
PosixGroupId integer 示例值:1001​
POSXI 组 ID。​
​
PosixUserId integer 示例值:1001​
POSXI 用户 ID。​
​
PosixSecondaryGroupIds integer[] 示例值:2001,2002​
第二用户组 IDs。​
​
​
​
​
​
请求示例​
​
POST /?Action=DescribeAccessPoints&Version=2025-01-01 HTTP/1.1​
Host: efs.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260116T080559Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260116/cn-beijing/efs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"FileSystemId": "efs-cnbjb24db2d21****",​
"PageSize": 10,​
"PageNumber": 1,​
"FileSystemPath": "/path_test",​
"AccessPointId": "ap-n7db****",​
"AccessPointName": "pointname_test",​
"VpcId": "vpc-30uexwepls3cw7r2qr2h2****",​
"ZoneId": "cn-beijing-b",​
"Language": "ZH"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260121174207026171232083F7****",​
"Action": "DescribeAccessPoints",​
"Version": "2025-01-01",​
"Service": "efs",​
"Region": "cn-beijing"​
},​
"Result": {​
"TotalCount": 1,​
"PageSize": 10,​
"PageNumber": 1,​
"AccessPoints": [​
{​
"AccessPointId": "ap-n7db****",​
"AccessPointName": "test",​
"Status": "Running",​
"PermissionGroupId": "pgroup-7201****",​
"PermissionGroupName": "test",​
"ZoneId": "cn-beijing-b",​
"ZoneName": "China (Beijing) B",​
"VpcId": "vpc-30uexwepls3cw7r2qr2h2****",​
"VpcName": "vpcname_test",​
"SubnetId": "subnet-3jhaxpk3qwrgg3pncme77****",​
"SubnetName": "subnetname_test",​
"Trn": "trn:efs:cn-beijing:210015****:filesystem/efs-cnbjb24db2d21****",​
"Domain": "cnbjb030b2711****.3hjdtujzi2cjk3nkipjjq****.cn-beijing.efs.ivolces.com",​
"FileSystemPath": "/path_test",​
"EnableIam": true,​
"CreateTime": "2025-09-02T14:22:17+08:00",​
"UpdateTime": "2025-09-02T14:22:17+08:00",​
"PosixUser": {​
"PosixGroupId": 1001,​
"PosixUserId": 1001,​
"PosixSecondaryGroupIds": [​
2001,2002​
]​
}​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter format is invalid.​
参数格式无效。​
400​
MissingParameter.FileSystemId​
The required parameter FileSystemId is not supplied.​
参数 FileSystemId 不能为空。​
400​
MissingParameter.AccessPointName​
The required parameter AccessPointName is not supplied.​
参数 AccessPointName 不能为空。​
400​
MissingParameter.VpcId​
The required parameter VpcId is not supplied.​
参数 VpcId 不能为空。​
400​
MissingParameter.SubnetId​
The required parameter SubnetId is not supplied.​
参数 SubnetId 不能为空。​
400​
MissingParameter.PermissionGroupId​
The required parameter PermissionGroupId is not supplied.​
参数 PermissionGroupId 不能为空。​
400​
InvalidParameter.AccessPointName​
The specified parameter AccessPointName is invalid.​
参数 AccessPointName 不合法。​
400​
LimitExceeded.AccessPointNumber​
The specified number of AccessPoint of the specified FileSystem exceeds the limit.​
指定文件系统的接入点个数已经达到上限。​
400​
AlreadyExist.Vpc​
There is existing AccessPoint of the FileSystem which in the specified VpcId.​
该文件系统已存在接入点处于该私有网络。​
403​
AlreadyExist.AccessPoint​
The specified AccessPoint is already exist.​
参数 AccessPoint 已存在。​
403​
OperationDenied.FileSystemUnhealthy​
The specified FileSystem is unhealthy.​
文件系统非健康状态。​
404​
NotFound.Subnet​
The specified Subnet is not exist or has been deleted.​
子网不存在或已删除。​
404​
NotFound.Vpc​
The specified Vpc is not exist or has been deleted.​
私有网络不存在或已删除。​
423​
OperationDenied.FileSystemBusy​
The specified FileSystem is busy.​
文件系统繁忙。​
500​
InternalError​
An internal error has occurred.​
内部错误。​
​
​
最近更新时间:2026.02.05 17:54:00
这个页面对您有帮助吗?
有用
有用
无用
无用