接口功能介绍
查询地区
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /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 |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 查询地区信息 | result | |
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| area | 否 | Array of Strings | 地区，值类型为string |
请求示例
请求url
/sdwan/area/list?province=浙江
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"area": ["杭州市", "宁波市", "温州市", "嘉兴市", "湖州市", "绍兴市", "金华市", "衢州市", "舟山市", "台州市", "丽水市"]
}
],
"totalCount": 11,
"currentCount": 11
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
