查询地区
更新时间 2026-09-04 13:58:55
最近更新时间: 2026-09-04 13:58:55
接口功能介绍
查询地区
接口约束
输入参数名称类长度不超过64，描述类长度不超过128
URI
GET /v4/sdwan/area/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| province | 否 | String | 省份，若不填则返回所有的省份，填了返回该身份下的地区 | 浙江省 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj | |
| error | String | 业务细分码，为product.module.code三段式码 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | 查询地区信息 | result | |
| totalCount | Integer | 总数 | 1 | |
| currentCount | Integer | 当前页数量 | 1 |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| area | Array of Strings | 地区，值类型为string | 杭州市 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "",
"description": "",
"error": "",
"returnObj": {
"result": [
{
"area": [
"杭州市",
"宁波市",
"温州市",
"嘉兴市",
"湖州市",
"绍兴市",
"金华市",
"衢州市",
"舟山市",
"台州市",
"丽水市"
]
}
],
"totalCount": 11,
"currentCount": 11
}
}
状态码
请参考 状态码
错误码
请参考 错误码
