接口功能介绍
文件系统的区域(zone)查询
接口约束
无
URI
GET /v4/sfs/zonelist
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 可用区所在的地域 ID | 81f7728662dd11ec810800155d307d5b | |
fileSystemType | 否 | String | 文件系统类型。取值范围:performance-性能型、capacity-标准型、hdd_e-标准型专属 | capacity | |
pageSize | 否 | Integer | 分页查询时每页包含的地域数 | 10 | |
pageNo | 否 | Integer | 列表的分页页码 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 返回状态码(800 为成功,900 为失败) | 800 | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为英文描述 | 成功 | |
returnObj | String | 参考[returnObj] | 参考 | returnObj |
errorCode | String | 业务细分码,为 product.module.code 三段式码。 | 参考 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
totalCount | String | 查询到的 zone 数量 | 1 | |
pageSize | String | 每页包含的 zone 数 | 1 | |
pageNo | String | 当前页码 | 10 | |
zoneList | String | 可用区信息列表 | zoneList |
表 zoneList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
zoneName | String | 可用区 Name | 南京3 | |
storageType | String | 文件存储类型。例:"capacity" | capacity | |
protocolType | Array of Strings | 文件传输协议类型。例:["nfs","cifs"] | ["nfs","cifs"] |
枚举参数
无
请求示例
请求url
无
请求头header
{}
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"returnObj":"{
"zoneList":"{"storageType":"capacity","zoneName":"南京3","protocolType":[""["nfs","cifs"]""]}","pageNo":"10","pageSize":"1","totalCount":"1"
}",
"description":"成功",
"errorCode":"参考",
"message":"SUCCESS",
"statusCode":"800"
}
状态码
请参考 状态码
错误码
请参考 错误码