接口功能介绍
i根据文件系统name和资源池ID，查询文件系统详情
接口约束
1.自2024年5月16日后，本接口会受到IAM权限管控，当子账号或委托调用该接口时，需具备“sfs:shares:get”权限。
URI
GET /v4/sfs/info-by-name
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 文件系统名称 | 参考请求示例 | |
| regionID | 是 | String | 资源池ID | 参考请求示例 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| msgDesc | String | 失败时的错误描述，一般为中文描述 | ||
| msgCode | String | 业务细分码，为product.module.code三段式码 | 参考结果码 | |
| returnObj | Object | 参考详情对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 弹性文件命名 | ||
| UID | String | 弹性文件功能系统唯一ID | ||
| resourceID | String | 资源ID（计费资源ID） | ||
| sfsSize | Integer | 大小（MB） | ||
| sfsType | String | 类型，capacity/performance | ||
| sfsProtocol | String | 挂载协议。nfs/cifs/smb | ||
| sfsStatus | String | 1 | ||
| usedSize | Integer | 已用大小,MB | ||
| createTime | Long | 创建时刻，epoch时戳，精度毫秒 | ||
| updateTime | Long | 更新时刻，epoch时戳，精度毫秒 | ||
| expireTime | Long | 过期时刻，epoch时戳，精度毫秒 | ||
| 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 | 挂载点数量 |
枚举参数
无
请求示例
请求url
GET https://sfs-global.ctapi.ctyun.cn/v4/sfs/info-by-name?resourceID=133418979b074a37a66fc2353e17f844&name=sfs-cstor-test11-sfs
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"sharePathV6": "",
"projectID": "0",
"sfsStatus": "available",
"onDemand": false,
"windowsSharePathV6": null,
"sfsType": "performance",
"regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"usedSize": 33,
"sharePath": "100.127.155.200:/mnt/sfs_perf/afb8195dd8e52cf873734dfb679de001_abp06qrr7r755eyl",
"windowsSharePath": "",
"name": "sfs-cstor-test11-sfs",
"expireTime": "2022-10-29T07:29:31Z",
"kmsUUID": "",
"sfsSize": 512,
"cephID": "abp06qrr7r755eyl",
"sfsProtocol": "nfs",
"azName": "az1",
"resourceID": "133418979b074a37a66fc2353e17f844",
"createTime": 1664436572000,
"mountCount": 0,
"UID": "9a0b96e8-a10b-5380-8dca-f2c450d6691d"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
