GB/T 42877-2023
基本信息
标准号:
GB/T 42877-2023
中文名称:气象数据服务接口规范
标准类别:国家标准(GB)
英文名称:Service interface specification for meteorological data
标准状态:现行
发布日期:2023-08-06
实施日期:2023-12-01
出版语种:简体中文
下载格式:.pdf .zip
下载大小:9033437
相关标签:
气象
接口
规范
标准分类号
标准ICS号:数学、自然科学>>07.060地质学、气象学、水文学
中标分类号:综合>>基础学科>>A47气象学
关联标准
出版信息
出版社:中国标准出版社
页数:36页
标准价格:59.0
相关单位信息
起草人:何文春、高峰、徐拥军、王琦、倪学磊、孙周军、宋智、何林、温建伟、郑波、刘媛媛
起草单位:国家气象信息中心、广东省气象探测数据中心、四川省气象探测数据中心、陕西气象信息中心、内蒙古自治区气象信息中心、华云信息技术工程有限公司
归口单位:全国气象基本信息标准化技术委员会(SAC/TC 346)
提出单位:中国气象局
发布部门:国家市场监督管理总局 国家标准化管理委员会
标准简介
本文件规定了气象数据服务接口的组成、名称、参数、返回码与返回数据结构,并描述了对应的证实方法。
本文件适用于气象数据服务接口的设计开发、调取应用和气象数据的提供、使用。
标准内容
ICS07.060
CCS A 47
中华人民共和国国家标准
GB/T42877—2023
气象数据服务接口规范
Service interface specification for meteorological data2023-08-06发布
国家市场监督管理总局
国家标准花管理委员会
2023-12-01实施
GB/T42877—2023
规范性引用文件
术语和定义
接口组成
接口名称
接口参数
返回码
返回数据结构
证实方法
附录A(资料性)
附录B(规范性)
附录C(规范性)
附录D(规范性)
参考文献
气象数据服务接口示例
接口参数定义
返回码取值含义
返回数据结构
GB/T42877—2023
本文件按照GB/T1.1一2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定起草。
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任本文件由中国气象局提出。
本文件由全国气象基本信息标准化技术委员会(SAC/TC346)归口。本文件起草单位:国家气象信息中心、广东省气象探测数据中心、四川省气象探测数据中心、陕西气象信息中心、内蒙古自治区气象信息中心、华云信息技术工程有限公司。本文件主要起草人:何文春、高峰、徐拥军、王琦、倪学磊、孙周军、宋智、何林、温建伟、郑波、刘媛媛I
1范围
气象数据服务接口规范
GB/T42877—2023
本文件规定了气象数据服务接口的组成、名称、参数、返回码与返回数据结构,并描述了对应的证实方法。
本文件适用于气象数据服务接口的设计开发、调取应用和气象数据的提供、使用。2规范性引用文件
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GB/T2260—2007
GB/T2659—2000
GB/T40153—2021
中华人民共和国行政区划代码
世界各国和地区名称代码
气象资料分类与编码
QX/T37—2020
气象台站历史沿革数据文件格式QX/T202—2013
QX/T327—2016
QX/T378—2017
3术语和定义
表格驱动码气象数据传输文件规范气象卫星数据分类与编码规范
公共气象服务产品文件命名规范下列术语和定义适用于本文件。3.1
居meteorologicaldata
气象数据
使用各种观测、探测手段获取的地球表面和地球大气的状态、现象及其变化过程的记录,以及以此为基础,通过各种技术方法进行加工处理生成的各类衍生和加工产品。[来源:GB/T40153—2021,3.1,有修改」3.2
[服务」接口
serviceinterface
信息系统为开放特定业务功能而发布的可供其他系统调用的应用编程函数。3.3
数据类别datacategory
具有共同属性(或特征)的数据的集合。[来源:GB/T38667—2020,3.9,有修改3.4
返回码returncode
服务接口调用后返回的、用以标识调用成功与否和错误原因等信息的状态码。注:一般用一个数字表示。
GB/T42877—2023
勾structurefor returneddata
返回数据结构
服务接口调用后返回的内存对象的数据组织方式。3.6
序列化
serialization
将计算机内存对象转换为可保存或传输的数据格式的过程注:保存或传输的数据格式一般有XML、JSON、JSONP、TEXT、HTML等。4
接口组成
接口应由4部分组成:
接口名称:表达数据访问的具体功能;a
接口参数:表达数据访问的输人条件;返回码:表达数据访问的调用状态;c
返回数据结构:表达返回数据的内存对象结构4.2一个接口可有一个或多个参数,每个参数应明确为必选或可选。接口示例见附录A,接口参数定义、返回码取值和返回数据结构应分别符合附录B、附录C和附录D的规定。5接口名称
5.1接口名称应由4部分组成:接口功能、数据类别、数据内容、主要条件。其中,接口功能、数据类别、数据内容不应为空,主要条件可为空。5.2接口名称宜采用小驼峰命名法1,命名格式为:(接口功能)(数据类别)(数据内容)(主要条件)。各组成部分的取值应符合表1的规则。表1接口名称各组成部分的取值规则组成部分
接口功能
数据类别
直接获取气象数据或资料的方法统计气象数据或资料的方法,包括:累计、极值、平均、计数等统计方法
地面气象资料
高空气象资料
海洋气象资料
气象辐射资料
农业气象和生态气象资料
数值预报产品
大气成分资料
接口功能的范围为提供数据,不包含回写数据。
接口功能及其代码取值宜根据需要扩展
符合GB/T40153—2021第5章的要求1)小驼峰命名法:软件编程中对编程对象的一种命名规则,名称由一个或多个单词连结而成,单词间不设分隔符,第一个单词的所有字母均为小写,从第二个单词开始之后的每个单词的首字母大写、其余字母均小写。2
组成部分
数据类别
数据内容
主要条件
6接口参数
要素代码列表
(By|In|Of)
(参数名称)
表1:
接口名称各组成部分的取值规则(续)含义
历史气候代用资料
气象灾害资料
天气雷达资料
卫星气象资料
科学试验和考察资料
气象服务产品
空间天气资料
其他资料
数据中所包含的全部或部分要素主要参数条件
GB/T42877—2023
符合GB/T40153—2021第5章的要求适用于站点类、格点类数据(要素形式)适用于信息类数据(文件形式)多个直接连接,不用分隔符
多个条件以“And\连接。
参数名称应符合附录B的规定,连接规则应符合6.2的规定
接口参数宜分为6类。其中,5类用于限定数据范围,分别按照数据的代码、要素、时间、空间、特殊属性5个主要维度定义;1类用于定义其他接口参数。参数类别及其描述的输人条件应符合表2的规定。
参数类别
数据代码类
要素范围类
时间范围类
空间范围类
特殊属性类
其他类
参数类别及其描述的输入条件
参数描述的输入条件
数据代码。如:数据代码(单个)数据的要素(含统计要素)范围。如:要素列表数据的时间范围。如:时间点、时间段数据的空间范围。如:经度和纬度范围数据的其他特殊属性范围。如:台风编号。分为“数值预报产品参数”“天气雷达资料参数”“卫星气象资料参数”“气象服务产品参数”等接口其他参数。如:结果排序字段6.2接口参数定义应由名称、含义、赋值类型、赋值格式、赋值示例、使用说明组成。其中,名称宜采用小驼峰命名法连接。
6.3接口参数定义应符合附录B的规定。其他接口参数宜根据需要按照接口参数定义扩展3
GB/T42877—2023
返回码
7.1返回码分为成功类、失败类。成功类的返回码取值为0。失败类的返回码取值为负数,取值规则为-(错误类别代码)(顺序号)。其中,错误类别代码和名称应符合表3的规定,顺序号为3位数字,从001开始。
3错误类别代码和名称
错误类别代码
错误类别名称
没有数据
用户验证失败
接口与数据不匹配
接口参数错误
没有访问权限
单次请求范围过大
服务器连接错误
数据库操作错误
数据文件错误
服务器处理错误
其他错误
返回码的取值含义应符合附录C的规定。未定义的返回码,宜根据需要按照返回码的取值含义扩展。
返回数据结构
8.1接口返回数据结构类别分为:站点类、格点类和信息类。返回数据结构类别、适用数据范围、返回数据内容应符合表4的规定
表4接口返回数据结构类别信息
返回数据结构类别
站点类
格点类
信息类
适用数据范围
站点类数据。如:地面气象资料、高空气象资料、海洋气象资料、气象辐射资料、农业气象和生态气象资料、大气成分资料、历史气候代用资料、气象灾害资料、空间天气资料等
格点类数据。如:数值预报产品等文件类数据。如:天气雷达资料、卫星气象资料、数值预报产品、科学试验和考察资料、气象服务产品、其他资料等
返回数据内容
二维站点数据及其描述信息、接口调用过程信息
二维格点场数据及其描述信息、接口调用过程信息
文件信息列表及其描述信息、接口调用过程信息
GB/T42877—2023
8.2接口返回数据结构描述应符合D.1的规定,站点类、格点类、信息类应分别按D.2、D.3和D.4的规定,用内存对象结构、序列化格式表达。9证实方法
9.1接口发布者应提供接口说明文档、测试方案说明文档。9.2审核接口说明文档应包括但不限于接口设计和服务功能、接口发布网站与在线支持、接口应用开发与实践等内容。
9.3审核测试方案说明文档应包括但不限于测试环境、测试准备、功能测试用例、非功能测试用例、测试流程等内容。
9.4模拟接口使用者应通过接口开发验证程序测试接口运行情况。验证程序应按照接口说明文档的接口名称和参数输人,调用后的返回码和返回数据结构与接口说明文档、测试方案说明文档应一致。5
GB/T42877—2023
A.1站点类数据服务接口示例
地面气象资料服务接口示例
附录A
(资料性)
气象数据服务接口示例
表A.1给出了指定时间的地面气象资料检索接口示例。表A.1
接口名称
dataCode
接口参数
elements
赋值类型
字符串
字符串
字符串
指定时间的地面气象资料检索接口示例getSurfEleByTime
赋值格式
数据代码的英文
多个以逗号(,)分隔
YYYYMMDDHH-
高空气象资料服务接口示例
赋值示例
SURF_ CHN_MUL
TEM,PRE
20080101000000
使用说明
表示:中国地面逐小
时数据
表示:检索温度、降
水数据
表示:2008年1月1
日00点00分00秒
表A.2给出了指定时间、垂直探测意义、经纬度范围的高空气象资料检索接口示例。表A.2
接口名称
dataCode
elements
接口参数
verticals
minLat
maxLat
minLon
maxLon
指定时间、垂直探测意义、经纬度范围的高空气象资料检索接口示例getUparEleInRectByTimeAndVertical含义
数据代码
要素代码
垂直探测
起始纬度
终止纬度
起始经度
终止经度
赋值类型
字符串
字符串
字符串
浮点数
浮点数
浮点数
浮点数
赋值格式
数据代码的英文
多个以逗号(,)
多个以逗号(,)
最多4位小数
最多4位小数
最多4位小数
最多4位小数
赋值示例
UPAR-_ GLB
MUL_FTM
TEM,PRS
使用说明
表示:全球高空定时
值数据
表示:检索温度、气
压数据
表示:标准气压层
表示:北纬32.1度
表示:北纬40.3度
表示:东经120.5度
表示:东经130.0度
必选/
必选/
A.1.3气象灾害资料服务接口示例表A.3给出了指定时间段、台风编号(国际)的台风资料检索接口示例表A.3
接口名称
dataCode
timeRange
接口参数
typhGIds
reportCenters
GB/T42877—2023
指定时间段、台风编号(国际)的台风资料检索接口示例getTyphByTimeRangeAndTyphGids含义
数据代码
时间段
台风编号
(国际)
编报中心
A.2格点类数据服务接口示例
赋值类型
字符串
字符串
字符串
字符串
赋值格式
数据代码的英文标识
前开后开:
(YYYYMMDDHHMISS,
YYYYMMDDHHMISS)
前开后闭:
(YYYYMMDDHHMISS,
YYYYMMDDHHMISSJ
前闭后开:
[YYYYMMDDHHMISS,
YYYYMMDDHHMISS)
前闭后闭:
[YYYYMMDDHHMISS,
YYYYMMDDHHMISSJ
多个以逗号(,)
多个以逗号(,)
数值预报产品格点场要素服务接口示例赋值示例
SEVP_WEFC-
TYP_WT
(20080101000000,
20080102000000J
WP242020
表A.4给出了指定时间、预报层次、预报时效的单场单要素检索接口示例。使用说明
表示:台风服务
表示:2008年1
月1日00时00
分00秒(不含)到
2008年1月2日
00时00分00秒
(含)
表示:2020年
西太平洋第24个
检测对象
表示:欧洲中期数
值预报中心
指定时间、预报层次、预报时效的单场单要素检索接口示例接口名称
接口参数
dataCode
数据代码
(单个)
getNafpEleGridByTimeAndLevelAndValidtime赋值类型
字符串
字符串
赋值格式Www.bzxZ.net
数据代码的英文
YYYYMMDDHH-
赋值示例
NAFP_FOR_FTM
_LOW_T639_NE
20080101000000
使用说明
表示:T639模式东北
半球低分辨率产品
表示:起报时间2008
必选/
必选/
年1月1日00点00
分00秒
GB/T42877—2023
接口名称
festEle
接口参数
festLevel
validTime
指定时间、预报层次、预报时效的单场单要素检索接口示例(续)getNafpEleGridByTimeAndLevelAndValidtime含义
预报要素(单
预报层次(单
预报时效(单
赋值类型
字符串
赋值格式
气压层次的整数值,
单位:百帕
赋值示例
预报时效,单位:
数值预报产品经纬度点要素服务接口示例使用说明
表示:检索温度要素
表示:检索1000百帕
气压层
表示:自起报时间预报
时效为24小时
表A.5给出了指定时间点、预报层次、预报时段、经纬度点的时间序列检索接口示例。表A.5
接口名称
dataCode
festEle
接口参数
festLevel
latLons
指定时间点、预报层次、预报时段、经纬度点的时间序列检索接口示例getNafpEleGridByTimeAndLevelAndValidtime含义
数据代码
时间(单个)
预报要素(单
预报层次(单
起始预报
终止预报
经纬度点
信息类数据服务接口示例
赋值类型
字符串
字符串
字符串
字符串
天气雷达资料服务接口示例
赋值格式
数据代码的英文
YYYYMMDDHH-
气压层次的整数值,
单位:百帕
预报时效,单位:
预报时效,单位:
lat/lon
赋值示例
NAFP_FOR
T639_NEHE
20080101000000
多个经纬度点以逗32.1/120.2
号(,)分隔
表A.6给出了指定时间段的天气雷达资料检索接口示例。8
使用说明
表示:起报时间2008
年1月1日00点00
分00秒
表示:检索温度要素
表示:检索1000百帕
气压层
表示:自起报时间预报
时效为24小时
表示:自起报时间预报
时效为48小时
表示:北纬32.1度,东
经120.2度的点
必选/
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。