接口功能介绍
根据资源池 ID 和海量文件的sfsUID,查询文件系统详情
接口约束
无
URI
GET /v4/oceanfs/info-sfs
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sfsUID | 是 | String | 海量文件功能系统唯一 ID | 参考[请求示例] | |
regionID | 是 | String | 资源池 ID | 参考[请求示例] |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
message | String | 响应描述,一般为英文描述 | SUCCESS | |
description | String | 响应描述,一般为中文描述 | 成功 | |
returnObj | Object | 参考[returnObj] | 参考[returnObj] | |
errorCode | String | 业务细分码,为 product.module.code 三段式码 | 参考[结果码] | |
error | String | 业务细分码,为 product.module.code 三段式码大驼峰形式 | 参考[结果码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
sfsName | String | 海量文件命名 | 参考[响应示例] | |
sfsUID | String | 海量文件功能系统唯一 ID | 参考[响应示例] | |
sfsSize | Integer | 大小(GB) | 500 | |
sfsType | String | 类型,3 种,capacity/performance/hdd_e | 参考[响应示例] | |
sfsProtocol | String | 挂载协议。2 种,nfs/cifs | 参考[响应示例] | |
sfsStatus | String | 海量文件状态。creating/available/unusable/delete_error/deleting | 参考[响应示例] | |
usedSize | Integer | 已用大小(MB) | 200 | |
createTime | Long | 创建时刻,epoch 时戳,精度毫秒 | 1699371030 | |
updateTime | Long | 更新时刻,epoch 时戳,精度毫秒 | 1699371030 | |
expireTime | Long | 过期时刻,epoch 时戳,精度毫秒 | 1699381030 | |
projectID | String | 资源所属企业项目 ID | 参考[响应示例] | |
isEncrypt | Boolean | 是否加密盘 | 参考[响应示例] | |
kmsUUID | String | 加密盘密钥 UUID | 参考[响应示例] | |
onDemand | Boolean | 是否按需订购 | 参考[响应示例] | |
regionID | String | 资源池 ID | 参考[响应示例] | |
azName | String | 多可用区下的可用区名字 | 参考[响应示例] | |
sharePath | String | linux 主机共享路径 | 参考[响应示例] | |
sharePathV6 | String | linux 主机 IPv6 共享路径 | 参考[响应示例] | |
windowsSharePath | String | win 主机共享路径 | 参考[响应示例] | |
windowsSharePathV6 | String | win 主机 IPv6 共享路径 | 参考[响应示例] | |
mountCount | Integer | 挂载点数量 | 10 | |
cephID | String | ceph底层的id | 参考[响应示例] |
枚举参数
无
请求示例
请求url
GET https://oceanfs-global.ctapi.ctyun.cn/v4/oceanfs/info-sfs?sfsUID=73725123-0de1-5424-8115-7da2a24f3dfb®ionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
无
响应示例
{
"returnObj":{
"updateTime":1678342191000,
"projectID":"0",
"usedSize":34,
"kmsUUID":"",
"isEncrypt":false,
"sfsSize":1024,
"onDemand":false,
"regionID":"b73e3ad4-417f-11ed-bad1-525400cc3b79",
"createTime":1678239529000,
"sharePath":"100.127.155.200:/mnt/sfs_mass/a7135589f022439c1edefc74b9336f7a_5czqobzhm0d4rjbx",
"mountCount":0,
"sfsType":"performance",
"windowsSharePath":"",
"expireTime":1709861929000,
"sfsProtocol":"nfs",
"azName":"az1",
"cephID":"5czqobzhm0d4rjbx",
"sfsUID":"73725123-0de1-5424-8115-7da2a24f3dfb",
"sharePathV6":"",
"sfsStatus":"available",
"windowsSharePathV6":"",
"sfsName":"yyx-sfs-test-003"
},
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码