接口功能介绍
查询并行文件支持的地域
接口约束
无
URI
GET /v4/hpfs/list-region
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageSize | 否 | Integer | 每页包含的元素个数范围(1-50),默认值为10 | 10 | |
pageNo | 否 | Integer | 列表的分页页码,默认值为1 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
message | String | 响应描述 | SUCCESS | |
description | String | 响应描述 | 成功 | |
returnObj | Object | 返回对象 | 参考returnObj | |
errorCode | String | 业务细分码,为 product.module.code 三段式码 | sfs.userDetail.empty | |
error | String | 业务细分码,为product.module.code三段式大驼峰码 | Sfs.UserDetail.Empty |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
regionList | Array of Objects | 查询的地域详情列表 | 参考regionList | |
totalCount | Integer | 支持并行文件的地域总数 | 10 | |
currentCount | Integer | 当前页码的元素个数 | 1 | |
pageSize | Integer | 每页个数 | 10 | |
pageNo | Integer | 当前页数 | 1 |
表 regionList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
regionID | String | 资源池ID | 9035c530814611e990660242ac110002 | |
regionName | String | 资源池名字 | 佛山资源池OS |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"regionList": [
{
"regionID": "9035c530814611e990660242ac110002",
"regionName": "佛山资源池OS"
},
{
"regionID": "100054c0416811e9a6690242ac110002",
"regionName": "保定os"
},
{
"regionID": "3b02346ac33911e9bee20242ac110006",
"regionName": "内蒙公有云2"
}
],
"totalCount":3,
"currentCount":3,
"pageSize":10,
"pageNo":1
}
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码