接口说明
用于检测风场数据服务是否正常运行。
接口地址
GET /yougis-windy-server/windfield/api/v1.0/is-ok
请求参数
无
返回结果
{
"success": true,
"message": "Service Valid!",
"version": "v1.0.3"
}
返回字段说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 服务是否正常,true表示正常 |
| message | String | 返回消息 |
| version | String | 服务版本号 |
在线测试
接口说明
用于按需补采指定时间段的风场数据。支持NOAA和真气网两个数据源,可补采全球或中国区域的数据。
接口地址
GET /yougis-windy-server/windfield/api/v1.0/crawl-windyPOST /yougis-windy-server/windfield/api/v1.0/crawl-windy
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | String | 是 | 数据来源,可选值:noaa、common、noaa,common(逗号分隔) |
| area | String | 是 | 数据区域,可选值:global、cn、global,cn(逗号分隔) |
| hour | String | 是 | 数据时间,格式:yyyymmddHH(单个)、yyyymmddHH,yyyymmddHH(多个)、yyyymmddHH-yyyymmddHH(范围) |
数据源说明:
• noaa:美国国家海洋和大气管理局数据,时间分辨率为6小时(00、06、12、18)
• common:真气网数据,全球数据时间分辨率为3小时,中国数据时间分辨率为1小时
• noaa:美国国家海洋和大气管理局数据,时间分辨率为6小时(00、06、12、18)
• common:真气网数据,全球数据时间分辨率为3小时,中国数据时间分辨率为1小时
返回结果(成功)
{
"success": true,
"message": "Crawl Windy Succeed"
}
返回结果(失败)
{
"success": false,
"message": "Crawl Windy Failed",
"failList": [
"noaa-global-2019060401",
"zhenqi-cn-2019060402"
]
}
在线测试
接口说明
用于获取指定类型、时间和区域的风场数据。支持全球、中国及各省份的数据获取,省份数据支持实时裁剪。
接口地址
GET /yougis-windy-server/windfield/api/v1.0/show-windy/{type}/{area}/{filename}
路径参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | String | 数据来源,可选值:noaa、common(common表示真气网) |
| area | String | 数据区域,可选值:global(全球)、cn(中国)、省份拼音简称(如zj、bj等) |
| filename | String | 文件名,格式:yyyymmddHH.json |
支持的省份编码
| 编码 | 省份 | 编码 | 省份 |
|---|---|---|---|
| ah | 安徽 | bj | 北京 |
| cq | 重庆 | fj | 福建 |
| gs | 甘肃 | gd | 广东 |
| gx | 广西 | gz | 贵州 |
| hi | 海南 | he | 河北 |
| hl | 黑龙江 | ha | 河南 |
| hb | 湖北 | hn | 湖南 |
| js | 江苏 | jx | 江西 |
| jl | 吉林 | ln | 辽宁 |
| nm | 内蒙 | nx | 宁夏 |
| qh | 青海 | sn | 陕西 |
| sd | 山东 | sh | 上海 |
| sx | 山西 | sc | 四川 |
| tj | 天津 | xj | 新疆 |
| xz | 西藏 | yn | 云南 |
| zj | 浙江 | tw | 台湾 |
数据获取策略:
• 全球数据(global):直接从存储的全球数据文件中读取
• 中国数据(cn):直接从存储的中国数据文件中读取
• 省份数据:从中国数据文件中实时裁剪指定省份范围的数据
• 全球数据(global):直接从存储的全球数据文件中读取
• 中国数据(cn):直接从存储的中国数据文件中读取
• 省份数据:从中国数据文件中实时裁剪指定省份范围的数据
最近数据查找机制:
当请求的数据文件不存在时,系统会自动向前查找最近可用的数据:
• 真气网-中国数据:向前查找最多6小时
• 真气网-全球数据:向前查找最多2小时
• NOAA-中国数据:向前查找最多18小时(3个时间点)
• NOAA-全球数据:向前查找最多18小时(3个时间点)
当请求的数据文件不存在时,系统会自动向前查找最近可用的数据:
• 真气网-中国数据:向前查找最多6小时
• 真气网-全球数据:向前查找最多2小时
• NOAA-中国数据:向前查找最多18小时(3个时间点)
• NOAA-全球数据:向前查找最多18小时(3个时间点)
返回结果示例
[
{
"header": {
"discipline": 0,
"disciplineName": "Meteorological products",
"gribEdition": 2,
"center": 7,
"centerName": "US National Weather Service - NCEP(WMC)",
"refTime": "2026-03-24T00:00:00.000Z",
"parameterCategory": 2,
"parameterCategoryName": "Momentum",
"parameterNumber": 2,
"parameterNumberName": "U-component_of_wind",
"parameterUnit": "m.s-1",
"surface1Type": 103,
"surface1TypeName": "Specified height level above ground",
"surface1Value": 10.0,
"nx": 341,
"ny": 165,
"numberPoints": 56265,
"lo1": 62.0,
"la1": 15.0,
"lo2": 147.0,
"la2": 56.0,
"dx": 0.25,
"dy": 0.25
},
"data": [2.6669946, 2.5469947, 2.3569946, ...]
},
{
"header": {
"parameterNumberName": "V-component_of_wind",
...
},
"data": [1.2345678, 1.3456789, 1.4567890, ...]
}
]
返回数据说明
返回数据为一个数组,包含两个元素:
- 第一个元素:U分量(东西方向风速),正值表示东风,负值表示西风
- 第二个元素:V分量(南北方向风速),正值表示北风,负值表示南风
每个元素包含:
- header:数据头信息,包含数据的时间、空间范围、分辨率等元数据
- data:风速数据数组,按网格点顺序排列