接口功能介绍
根据资源池 ID 和文件系统name,查询文件系统剩余容量
接口约束
无
URI
GET /v4/sfs/free-storage
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池 ID | 参考[请求示例] | |
name | 是 | String | 文件系统名称 | 参考[请求示例] |
请求参数
请求头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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
fuid | String | 文件系统ID | 参考[响应示例] | |
name | String | 文件系统名称 | 参考[响应示例] | |
regionID | String | 资源池 ID | 参考[响应示例] | |
freeSize | String | 文件系统剩余容量 | 参考[响应示例] |
枚举参数
无
请求示例
请求url
GET https://sfs-global.ctapi.ctyun.cn/v4/sfs/free-storage?regionID=81f7728662dd11ec810800155d307d5b&name=sfs-test-02
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"fuid": "487dea6c-938c-5ef4-abae-b8a4d59671d3",
"name": "sfs-test-02",
"freeSize": "512000MB"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码