《《气象数据服务接口规范》》由会员分享，可在线阅读，更多相关《《气象数据服务接口规范》（32页珍藏版）》请在金锄头文库上搜索。
1、ICS07.060A 47中华人民共和国国家标准GB/T XXXXXXXXX气象数据服务接口规范API specification for Meteorological Data Service点击此处添加与国际标准一致性程度的标识（送审稿）2020.06.20XXXX - XX - XX发布XXXX - XX - XX实施GB/T XXXXXXXXX目次前言II1范围12规范性引用文件13术语和定义13.1气象数据.13.2服务接口.13.3返回码.13.4返回数据结构.13.5序列化.23.6驼峰命名法.24接口组成.25接口命名.26接口参数.36.1参数分类.36.2参数定义.37返回
2、码.37.1返回码分类.37.2返回码定义.48返回数据结构.4附录A（规范性附录）接口示例5附录B（规范性附录）常用接口参数定义清单9附录C（规范性附录）常用返回码定义清单17附录D（规范性附录）返回数据结构18参考文献32前言本标准按照GB/T 1.12009给出的规则起草。本标准由全国气象基本信息标准化技术委员会（SAC/TC 346）提出并归口。本标准起草单位：国家气象信息中心、广东省气象探测数据中心、四川省气象探测数据中心、内蒙古气象信息中心、陕西气象信息中心、华云信息技术工程有限公司。本标准主要起草人：何文春、高峰、徐拥军、王琦、倪学磊、孙周军、宋智、温建伟、何林29气象数据服务接
3、口规范1 范围本标准规定了气象数据服务接口的组成、名称、参数、返回码与返回数据结构。本标准适用于政府行业、公司企业中数据服务系统API的设计开发，用以发布、共享和应用气象数据。2 规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。QX/T 2332014 气象数据库存储管理命名QX/T 1022009 气象资料分类与编码3 术语和定义下列术语和定义适用于本文件。3.1气象数据 meteorological data对使用各种观、探测手段获取的大气状态、现象及其变化过程的记录以
4、及各类衍生资料进行通信、解释和处理而使用的信息的形式化表示。 QX/T 2332014，定义3.23.2服务接口 application programming interface（API）数据服务系统提供给应用系统访问数据的应用编程接口。3.3返回码 return code接口调用后返回的状态码，用以标识调用成功与否、错误原因等信息，一般用一个数字表示。3.4返回数据结构 structure for returned data接口调用后返回的内存对象的数据结构。3.5序列化 serialization将计算机内存对象转换为可保存或传输的数据格式的过程。注：序列化的格式一般有XML、JSON、
5、JSONP、TEXT、HTML等。3.6驼峰命名法 Camel-Case软件编程中的一套命名规则（惯例）。注：变量名或函数名由一个或多个单词连结而成，单词间没有分隔符，第一个单词的字母均为小写，从第二个单词开始以后的每个单词的首字母大写、其余字母小写。4 接口组成接口由3部分组成：接口名称、接口参数、返回码与返回数据结构。其中，接口名称表达数据访问的具体功能，接口参数表达数据访问的输入条件，返回码与返回数据结构表达数据访问的调用状态、返回数据的内存结构。一个接口可以有一个或多个参数，每个参数须明确为必选或可选。接口示例见附录A。5 接口名称接口名称应由接口功能、资料类型、数据内容、主要条件等4
6、个部分组成，其中接口功能、资料类型、数据内容不可为空，主要条件可空。接口名称采用驼峰命名法，命名格式为：接口功能资料类型数据内容主要条件。各部分的取值规则见表1。表1 接口名称各组成部分的取值规则组成部分取值含义备注接口功能get检索气象数据、元数据等接口功能及其取值可按需扩展stat统计气象数据资料类型Surf地面气象资料参照QX/T 1022009 中5.1Upar高空气象资料Ocen海洋气象资料Radi气象辐射资料Agme农业气象和生态气象资料Nafp数值预报产品Cawn大气成分资料Hpxy历史气候代用资料Disa气象灾害资料Rada雷达气象资料Sate卫星气象资料表1 接口名称各组成部
7、分的取值规则（续）组成部分取值含义备注Scex科学试验和科考资料Sevp 气象服务产品Othe其他数据内容Ele要素适用于站点、格点场等要素数据File文件适用于文件形式的数据要素代码列表具体的要素多个直接连接，不用分隔符主要条件By|In|Of参数名主要的参数条件多个以“And”连接；参数名见“6.2 参数定义”6 接口参数6.1 参数分类接口参数按照对目标气象数据约束的维度，分为五类，参数分类及其描述的输入条件见表2。表2 参数分类及其描述的输入条件参数分类参数描述的输入条件资料类资料的范围。如，资料代码。要素属性类资料的要素（含统计要素）范围。如，要素列表。时间属性类资料的时间范围。如，
8、时间点。空间属性类资料的空间范围。如，经纬度范围。其他属性类不同资料的其他特殊属性范围，如，台风编号按资料种类，该类参数又分为“台风资料参数”、“数值预报产品参数”、“雷达气象资料参数”、“卫星气象资料参数”、“气象服务产品参数”等。6.2 参数定义参数的定义由参数名称、含义、赋值类型、赋值格式等4部分组成，其中，参数名称采用驼峰命名法；赋值类型指整数、浮点数、字符串等编程语言的数据类型。气象数据访问常用接口参数定义清单见附录B，可按需、按规则、参照示范进行扩展。7 返回码7.1 返回码分类按照返回码表征的调用状态和错误原因，对返回码进行分类。分类代码及名称见表3。表3 返回码分类的代码及名称
9、分类代码分类名称0成功1用户验证失败2接口与资料不匹配表3 返回码分类的代码及名称（续）分类代码分类名称3接口参数错误4没有访问权限5单次请求范围过大6服务器连接错误7数据库操作错误8数据文件错误9服务器处理异常10其他错误7.2 返回码定义返回码的定义由返回码取值和含义2部分组成。对于“成功”类别的返回码取值：调用成功且有数据，取值0；调用成功但无数据，取值-1。对于其他类别的返回码取值规则为：-分类代码顺序号。常用的返回码定义见附录C，可按需、按规则、参照示范进行扩展。8 返回数据结构服务接口返回数据的结构分为三类：站点类、格点类和文件信息类，结构及其适用数据范围见表4。返回数据结构见附录
10、D，使用两种形式进行表达：内存对象结构（采用常用编程语言描述）和序列化格式（采用常用序列化格式描述），其他语言和序列化格式可参照自行定义。表4 返回数据结构及其适用数据范围数据结构类别适用数据数据内容站点类站点数据如：地面气象资料、高空气象资料等二维站点数据及其描述信息、接口调用过程信息格点类格点场数据如：数值预报产品、智能网格预报产品等二维格点场数据及其描述信息、接口调用过程信息文件信息类文件数据如：雷达气象资料、卫星气象资料、气象服务产品等文件信息列表及其描述信息、接口调用过程信息附录A （资料性）接口示例A.1 站点资料服务接口示例A.1.1 地面资料服务接口示例作为示例，表A.1给出了
11、指定时间的地面资料检索接口。表A.1 指定时间的地面资料检索接口接口名称getSurfEleByTime参数代码中文名参数类型赋值格式/示例必选/可选dataCode资料代码字符串示例：SURF_CHN_MUL_HOR必选elements要素代码字符串多个以逗号(,)分隔必选times时间字符串YYYYMMDDHHMISS必选返回码见附录C返回数据结构站点类返回数据结构，见附录D.2A.1.2 高空资料服务接口示例作为示例，表A.2给出了指定时间、高度、经纬度范围的高空资料检索接口。表A.2 指定时间、高度、经纬度范围的高空资料检索接口接口名称getUparEleInRectByTimeAnd
12、Vertical参数代码中文名参数类型赋值格式/示例必选/可选dataCode资料代码字符串示例：UPAR_GLB_MUL_FTM必选elements要素代码字符串多个以逗号(,)分隔必选times时间字符串YYYYMMDDHHMISS必选verticals垂直探测意义字符串多个以逗号(,)分隔必选minLat起始纬度浮点数最多4位小数必选maxLat终止纬度浮点数最多4位小数必选minLon起始经度浮点数最多4位小数必选maxLon终止经度浮点数最多4位小数必选返回码见附录C返回数据结构站点类返回数据结构，见附录D.2A.1.3 台风资料服务接口示例作为示例，表A.3给出了指定时间段、台风编号（国际）的台风资料检索接口。表A.3 指定时间段、台风编号（国际）的台风资料检索接口接口名称getTyphByTimeRangeAndTyphG
