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