动态代理账号
动态代理账号
查询动态代理地区
GET /open-api/v1/dynamic/regions 接口参考。
查询动态代理地区
GET /open-api/v1/dynamic/regions
Base URL:https://api.ipfbs.com/gin。
认证
在请求头传入 X-API-Key。
路径与查询参数
| 字段 | 位置 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|---|
level |
query | string |
是 | enum: COUNTRY, PROVINCE, CITY | 地区层级 |
parent_code |
query | string |
否 | minLength: 1; maxLength: 64 | 上级地区编码;level=PROVINCE 或 CITY 时必填,level=COUNTRY 时不得传入 |
请求示例
curl --request GET \
--url 'https://api.ipfbs.com/gin/open-api/v1/dynamic/regions?level=COUNTRY' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
成功响应中的 data
接口使用 code、msg、data、next 响应结构。HTTP 200 也可能包含非零业务错误码;先检查 code。
| 字段 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
data |
object[] |
否 | — | 业务数据;失败时为 null |
data[].region_code |
string |
否 | — | 平台地区编码 |
data[].name |
string |
否 | — | 按 X-LANG 返回的地区名称 |
data[].level |
string |
否 | enum: COUNTRY, PROVINCE, CITY | 地区层级 |
data[].parent_code |
string |
否 | — | 上级地区编码;国家层级为空 |
data[].has_children |
boolean |
否 | — | 是否存在下级可用地区 |
接口说明
按 level 查询统一地区目录;查询省或城市时必须传上级 parent_code