接口功能介绍

根据资源池 ID ，查询用户已开通文件系统

接口约束

在2024年10月之后，弹性文件将支持VPCE终端节点服务接入，按资源池维度陆续上线，新建的文件系统默认支持VPCE。在弹性文件服务有关挂载地址的查询接口中将增加"vpceSharePath"字段，用于展示文件系统下每个VPC的挂载地址。

· 原挂载地址相关字段无改动，云主机、容器用户无须适配新字段。

· 若为物理机（标准裸金属）用户，须使用vpceSharePath字段中的挂载地址。

· 该字段仅适用于可用区资源池，即使用资源池概况信息查询接口查询带对接的资源池信息，如资源池信息"regionVersion": "v4.0"，即可使用。

URI

GET /v4/sfs/opend-list-sfs

路径参数
无

Query参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池 ID	参考[请求示例]
pageNo	否	Integer	查询的页码。默认为1	1
pageSize	否	Integer	每页的元素个数。默认为10	10

请求参数

请求头header参数
无

请求体body参数
无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码(800 为成功，900 为失败)	800
message	String	响应描述，一般为英文描述	参考[响应示例]
description	String	响应描述，一般为中文描述	参考[响应示例]
returnObj	Object	参考[returnObj]		参考[returnObj]
errorCode	String	业务细分码，为 product.module.code 三段式码.参考[结果码]	参考[结果码]
error	String	业务细分码，为product.module.code三段式码大驼峰形式	参考[结果码]

表 returnObj

参数	参数类型	说明	示例	下级对象
list	Array of Objects	查询信息列表		参考[list1]
total	Integer	资源池下用户弹性文件总数	10
currentCount	Integer	当前查询到的弹性文件个数	10
totalCount	Integer	资源池下用户弹性文件总数	10
pageSize	Integer	每页包含的元素个数	10
pageNo	Integer	当前页码	1

表 list1

参数	参数类型	说明	示例	下级对象
sfsName	String	弹性文件命名	参考[响应示例]
sfsUID	String	弹性文件功能系统唯一 ID	参考[响应示例]
sfsSize	Integer	大小（GB）	500
sfsType	String	类型，2 种，capacity/performance	参考[响应示例]
sfsProtocol	String	挂载协议。2 种，nfs/cifs	参考[响应示例]
sfsStatus	String	弹性文件状态。 5种，creating、available、fail、deleted、unusable	参考[响应示例]
usedSize	Integer	已用大小（MB）	200
createTime	Long	创建时刻，epoch 时戳，精度毫秒	1699371030]
updateTime	Long	更新时刻，epoch 时戳，精度毫秒	1699371030
expireTime	Long	过期时刻，epoch 时戳，精度毫秒	1699471030
projectID	String	资源所属企业项目 ID	参考[响应示例]
isEncrypt	Boolean	是否加密盘	参考[响应示例]
kmsUUID	String	加密盘密钥 UUID	参考[响应示例]
vpceSharePath	Array of Objects	仅可用区资源池涉及该字段，即通过资源池概况信息查询接口中"regionVersion": "v4.0"的资源池适用本字段。当该资源池支持VPCE接入弹性文件服务后，新建的文件系统在使用查询接口时会返回该字段，该字段中包含每个VPC对应的挂载地址，与原挂载地址相比，不仅可以挂载云主机、容器，还可用于挂载标准裸金属。同时原挂载地址仍可用，云主机、容器用户可无须再适配本字段。		list2
onDemand	Boolean	是否按需订购	参考[响应示例]
regionID	String	资源池 ID	参考[响应示例]
azName	String	多可用区下的可用区名字	参考[响应示例]
sharePath	String	linux 主机共享路径	参考[响应示例]
sharePathV6	String	linux 主机 IPv6 共享路径	参考[响应示例]
windowsSharePath	String	win 主机共享路径	参考[响应示例]
windowsSharePathV6	String	win 主机 IPv6 共享路径	参考[响应示例]
mountCount	Integer	挂载点数量	8
cephID	String	ceph底层的id	参考[响应示例]
phySharePath	String	linux物理机共享路径，若支持物理机挂载，则显示该字段，否则该字段不存在。通过资源池概况信息查询接口中"regionVersion": "v3.0"的资源池适用本字段

表 list2

参数	参数类型	说明	示例
vpcID	String	vpc的ID	vpc-66jrjem533
vpcName	String	vpc名称	vpc-tzbtest
sharePath	String	linux 主机共享路径	参考响应示例
sharePathV6	String	linux 主机 IPv6 共享路径	参考响应示例
windowsSharePath	String	win 主机共享路径	参考响应示例
windowsSharePathV6	String	win 主机 IPv6 共享路径	参考响应示例

枚举参数

无

请求示例

请求url

GET https://sfs-global.ctapi.ctyun.cn/v4/oceanfs/opend-list-sfs?regionID=81f7728662dd11ec810800155d307d5b

请求头header

无

请求体body

无

响应示例

{
    "returnObj":{
        "total":1,
        "totalCount":1,
        "currentCount":1,
        "list":[
            {
                "updateTime":1671076697000,
                "projectID":"0",
                "usedSize":33,
                "kmsUUID":"",
                "isEncrypt":false,
                "sfsSize":500,
                "vpceSharePath": [{"vpcID": "vpc-66jrjem533", "windowsSharePathV6": "", "windowsSharePath": "", "vpcName": "vpc-tzbtest", "sharePath": "192.168.0.7:/mnt/sfs_mass/d28efd74174cd8d98ceda43e6e386013_b0k6ok3urrhr1pym", "sharePathV6": ""}],
                "onDemand":true,
                "resourceID":"0685dd5d29f54847a50ffe07d705308d",
                "regionID":"b73e3ad4-417f-11ed-bad1-525400cc3b79",
                "createTime":1670809851000,               "sharePath":"100.127.155.200:/mnt/sfs_mass/d28efd74174cd8d98ceda43e6e386013_b0k6ok3urrhr1pym",
                "mountCount":0,
                "sfsType":"performance",
                "windowsSharePath":"",
                "expireTime":32503737600000,
                "sfsProtocol":"nfs",
                "azName":"az1",
                "cephID":"b0k6ok3urrhr1pym",
                "sfsUID":"e1a18059-83fe-5426-83b9-2cd0924cf6b0",
                "sharePathV6":"",
                "sfsStatus":"available",
                "windowsSharePathV6":"",
                "sfsName":"sfs-yyx-03"
            }
        ],
        "pageSize":10,
        "pageNo":1
    },
    "message":"SUCCESS",
    "description":"成功",
    "statusCode":800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性文件服务

弹性文件服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性文件服务

弹性文件服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码