/data/cities
1.接口描述
该API的功能按省份查询该省所有城市。
请求方式：
POST
请求URL：
https://cloudapi.deepfinch.com/data/cities
调试工具
2.请求参数
2.1 请求头域
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API调用凭证信息，详细信息请参考API调用 |
| X-DF-API-SECRET | string | 是 | API调用凭证信息，详细信息请参考API调用 |
2.2 请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| province | string | 是 | 省份名称，支持模糊匹配（如 "浙江" 可匹配 "浙江省"） |
3.返回参数
正常响应 （200）
| 字段 | 类型 | 描述 |
|---|---|---|
| request_id | string | 本次请求的 id |
| status | string | 状态。正常为 OK ，其他值表示失败。详见错误码 |
| result | object | 查询结果 |
其中result的字段如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| province | string | 实际命中的完整省名（模糊匹配时可能与入参不同） |
| cities | array | 该省下属城市名称数组 |
| total | int | 城市数量 |
输出示例：
{
"request_id": "TID9e128e1ada9e4f5dab62e32797d793a2",
"status": "OK",
"result": {
"province": "北京市",
"cities": [
"北京市"
],
"total": 1
}
}
4.错误码
| 状态码 | status 字段 |
说明 |
|---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
QUERY_FAILED | 查询失败 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
输出示例：
{
"status": "RATE_LIMIT_EXCEEDED",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}