聚合云数据开放平台API接口文档 V1.0

API函数使用手册v1.1新一代信息系统建设浦发银行架构建模管理工具平台建设项目数据建模工具及实施服务API函数使用手册V1.1文档编排规范及约定【文档编排规范及约定】的内容仅是对本文档编写的规范和约定进行描述，文档编写人员须严格按照本规范和约定进行编写，在文档正式发布时删除该部分内容；须填写“文档修订控制记录”；文档目录须更新为最新的，与实际内容相对应；目录1.前言 (4)1.1.编写目的 (4)1.2.适用范围 (4)1.3.预期读者 (4)2.P OWER D ESIGNER API简介 (5)2.1.概述 (5)2.2.查询API帮助文档 (5)2.3.常用API简介 (15)3.P OWER D ESIGNER脚本开发示例 (43)3.1.概述 (43)3.2.创建和打开模型 (43)3.3.浏览和修改模型的集合 (44)3.4.操纵知识库 (45)3.5.PDM模型的正向工程 (45)3.6.PDM模型的反向工程 (48)1.前言1.1.编写目的为了指导开发人员初步掌握Sybase PowerDesigner API帮助文档的查询方法、了解Sybase PowerDesigner脚本程序的开发步骤，特编写此手册。

本手册分为两部分，第一部分介绍了API帮助文档的目录结构和常用的API类库；第二部分并针对一些常用的使用场景，给出了API 函数的使用示例。

1.2.适用范围本手册叙述的产品特性、操作命令、用户界面均基于下列版本的产品Window 2008 Enterprise SP2SQL Server 2008 R21.3.预期读者Sybase PowerDesigner脚本开发人员2.PowerDesigner API简介2.1.概述PowerDesigner客户端提供了丰富的API及详尽的说明文档，开发人员通过编写VBS脚本、调用API，可以执行大批量、重复性的模型管理和维护任务。

2.2.查询API帮助文档2.2.1.打开方法用户可以通过点击PowerDesigner客户端的[Help -> Metamodel Objects Help] 菜单项，打开PowerDesigner API帮助文档。

共享平台API接口规范版本: 0.7s携程旅行网目录1.前言 (4)1.1功能描述 (4)1.2阅读对象 (4)1.3业务术语 (4)1.4技术服务............................................................................................................... 错误!未定义书签。

2.接口参数说明 (5)2.1普通政策请求参数 (5)2.2特惠政策请求参数 (5)2.3特价政策请求参数 (16)3.示例Xml请求 (16)3.1普通政策 (16)3.2特惠政策 (16)3.3特价政策 (19)4.错误代码整理 (21)4.1错误代码规则说明 (21)4.2错误固定标识及错误代码分类说明 (21)4.3目前已知错误代码列表 (21)版本历史1.前言1.1 功能描述为了提高代理商在携程网的政策投放效率，满足其业务需求，由携程机票研发部门开发了一套代理商政策导入接入API。

本文档是为了描述相应的接口规范。

1.2 阅读对象面向具有一定技术实力的代理商公司相应的技术人员1.3 业务术语1.4 接口API导入必读API导入入口：/Flight-Product-TradeAPI/PolicyWS.asmx接口参数：username: 用户名password: 密码（格式: MD5(UTF-8(“username#password”)）)execType: 执行类型，只支持FullADD(全量上传), ADD(增量上传)gzipRequestBytes: 请求报文字节数组，是对报文进行GZIP后产生的字节流接口响应格式：返回的是对报文GZIP后的base64位格式的文本编码目前每日最大请求次数是500次1.5 技术服务前期请直接联系相应的票台关联业务人员2.接口参数说明2.1 普通政策请求参数2.2 特惠政策请求参数2.3 特价政策请求参数暂不提供2.4 返回参数3.示例Xml请求3.1 普通政策<?xml version="1.0"encoding="UTF-8"?><TradePolicyRequest xmlns="urn:ctrip:api:flight:trade:message:PolicyService:v1"> <TradePolicyImportRequest><ExecType>ADD</ExecType><PolicyType>COMMON</PolicyType><PolicyList><Policy><PolicyCode>December</PolicyCode><ProductUnit><EffectDate>2013-12-24T00:00:00</EffectDate><ExpiryDate>2013-12-24T23:59:00</ExpiryDate><ItineraryList><Itinerary><AirlineCode>CA</AirlineCode><DeptAirport>PEK</DeptAirport><ArrvAirport>URC,KWL,WUH,HRB,DLC,SHE</ArrvAirport><FlightEffectDate>2013-12-24T00:00:00</FlightEffectDate><FlightExpiryDate>2013-12-25T00:00:00</FlightExpiryDate><WeekDays>1357</WeekDays><BookingClass>Y,B,L</BookingClass><FlightControl><FlightNumSaleLimitFlag>1</FlightNumSaleLimitFlag><FlightNumRangeList><FlightNumRange><FlightNumStart>5000</FlightNumStart><FlightNumStop>5001</FlightNumStop></FlightNumRange></FlightNumRangeList></FlightControl></Itinerary></ItineraryList></ProductUnit><PriceUnit><ReturnPoint>8</ReturnPoint><ReturnPrice>4</ReturnPrice></PriceUnit></Policy></PolicyList></TradePolicyImportRequest></TradePolicyRequest>3.2 特惠政策请求格式：<?xml version="1.0"encoding="UTF-8"?><TradePolicyRequest xmlns="urn:ctrip:api:flight:trade:message:PolicyService:v1"><TradePolicyImportRequest><ExecType>ADD</ExecType><PolicyType>SPECIAL</PolicyType><PolicyList><Policy><PolicyCode>Inventory</PolicyCode><ProductUnit><ProductType>0</ProductType><EffectDate>2014-01-01T00:00:00</EffectDate><ExpiryDate>2014-01-31T23:59:00</ExpiryDate><MinAdvanceDays>0</MinAdvanceDays><MaxAdvanceDays>365</MaxAdvanceDays><MinStopDays>0</MinStopDays><MaxStopDays>0</MaxStopDays><MinPassengerNum>1</MinPassengerNum><ItineraryList><Itinerary><AirlineCode>MU</AirlineCode><DeptAirport>NKG</DeptAirport><ArrvAirport>PVG</ArrvAirport><FlightEffectDate>2014-01-01T00:00:00</FlightEffectDate><FlightExpiryDate>2014-01-31T00:00:00</FlightExpiryDate><FlightDepartTimeLimitRemarks/><WeekDays>1234567</WeekDays><BookingClass>Y</BookingClass><BookingClassNote/><FlightNo>1989</FlightNo><FlightControl/></Itinerary></ItineraryList><CabinClass>Y</CabinClass><RefundBasis>D</RefundBasis><RefundChangeEndorseRemarks>10-2-20^20-0-50^0</RefundChangeEndorseRemarks> <RefundChangeEndorseNote>for test only</RefundChangeEndorseNote><MinPassengerAge>0</MinPassengerAge><MaxPassengerAge>100</MaxPassengerAge><Remarks/></ProductUnit><PriceUnit><PriceInfo><PrintPrice>0</PrintPrice><SalePrice>880</SalePrice><SetPrice>880</SetPrice></PriceInfo><ReturnPoint>0</ReturnPoint><ReturnPrice>0</ReturnPrice></PriceUnit><InventoryUnit><InventoryType>FIX</InventoryType><SaleableQuantity>5</SaleableQuantity></InventoryUnit><ServiceUnit><OfficeNos/><AutoTicketed>false</AutoTicketed><NeedCreatePNR>true</NeedCreatePNR><NeedChangePNR>true</NeedChangePNR><NeedProvideInvoice>1</NeedProvideInvoice><NeedPata>true</NeedPata><NeedConfirm>false</NeedConfirm><NeedProvideFrequentFlyerScore>false</NeedProvideFrequentFlyerScore><AllowPayDirectly>true</AllowPayDirectly><WorkTimeLimitRemarks>0000-2359,0000-2359,0000-2359,0000-2359,0000-2359,0000-2359,0000-2359</ WorkTimeLimitRemarks><TicketedSpeed>0</TicketedSpeed></ServiceUnit></Policy></PolicyList></TradePolicyImportRequest></TradePolicyRequest>代码示例：ServiceInvokeDemo.7z3.3 特价政策暂不提供3.4 返回结果共有三种返回格式：a. 成功b. 政策错误c. 服务类或者请求错误4.错误代码整理4.1 错误代码规则说明错误代码由三部分组成，两位固定标识+两位错误代码分类+两位业务码+两位错误码4.2 错误固定标识及错误代码分类说明1，2位为固定标识: 803，4位错误代码分类，目前分为以下几类:00: 未知错误01: 请求合法性验证错误(比如销售日期结点不支持输入一个整型值)02: 请求有效性验证错误(比如销售起始日期不能大于其结束日期)03: 业务逻辑类验证错误(比如要求导入一个无效政策)5，6位表示政策类型，可以分为以下几类:00: 特惠政策01: 普通政策02: 特价政策4.3 目前已知错误代码列表注意事项：1、全量上传每次支持100W条政策，增量上传每次支持5W条政策2、全量上传操作后需价格20分钟可以进行下一次操作，增量上传没有间隔时间3、全量上传会覆盖删除接口和excel导入的政策，不会删除手工录入的政策。

【汉印云打印】开放API接口文档版本(1.1)2018年10月汉印云打印平台.接口文档V1.1目录1.概述： (1)2.打印接口： (1)2.1API接口地址 (1)2.2API请求方式 (1)2.3API调用方法 (1)2.4系统级和应用级的参数 (2)2.5签名加密算法如下： (3)2.6加密示例： (3)2.7需要传递给API的参数是： (3)3.APP调用功能： (4)3.1添加打印机 (4)3.2删除打印机 (5)3.3打印订单 (6)3.4查询打印机状态 (7)3.5查询打印完成情况 (8)4.内容排版标记参数 (10)5.注意事项 (13)6.版本信息： (14)1.概述：汉印云打印平台是以互联网为基础，整合云打印机资源，构建漫游共享的打印平台，向所有用户提供随时随地高质量、标准化的打印服务，包含了云平台、API、云打印服务器、云打印机等，产品广泛应用于快递业、超市、餐饮、社区店、生鲜店等，并致力于成为国内一线互联网云平台。

本文档提供了面向互联网开放的API接口，可有效的实现汉印云打印平台和应用开发者之间的对接，帮助用户和开发者方便地使用云平台的架构和功能。

2.打印接口：本节介绍如何发送数据到汉印云API并通过云平台输出打印指令，以及对应的状态返回码。

2.1API接口地址/api/values2.2API请求方式POST2.3API调用方法发送打印数据到汉印云API请求以及参数应该用POST方法发送。

汉印云API将根据收到的信息验证请求的有效性反馈对应的状态码。

2.4系统级和应用级的参数发送打印数据到汉印云请求必须包含以下参数（系统级参数和应用级参数）。

系统级参数应用级参数2.5签名加密算法如下：Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)，串在一起后进行MD5加密然后再转成大写，括号里面的参数只需要传入值。

2.6加密示例：000001hcs100171600521498469357ED93DC463FA44A7F8BD1919AE282C 310这是未加密前串在一起的排列，然后把这串字符进行MD5加密得到的结果就是sign的值Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)2.7需要传递给API的参数是：UserID、PrinterNo、TimeStamp这3个参数是需要提交给API的。

基于GO的icp备案查询api调用代码实例代码描述：基于GO的icp备案查询api调用代码实例代码平台：聚合数据packagemainimport("io/ioutil""net/http""net/url""fmt""encoding/json")//----------------------------------// 域名备案查询调用示例代码－聚合数据// 在线接口文档：/docs/68//----------------------------------constAPPKEY = "*******************"//您申请的APPKEYfunc main(){//1.备案查询Request1()}//1.备案查询func Request1(){//请求地址juheURL :="/japi/beian"//初始化参数param:=url.Values{}//配置请求参数,方法内部已处理urlencode问题,中文参数可以直接传参param.Set("key",APPKEY) //应用APPKEY(应用详细页查询)param.Set("type","") //0通过网站名称查询，如：聚合数据平台 &lt;br/&gt;1通过域名查询，如:&lt;br/&gt;2通过网站首页查询，如&lt;br/&gt;3通过许可证号查询查询，如：苏ICP 备14006450号-3&lt;br/&gt;5通过主办单位名称查询，如：苏州新科兰德科技有限公司param.Set("keyword","") //对应type的值，如：param.Set("v","") //版本号，固定1.0//发送请求data,err:=Get(juheURL,param)iferr!=nil{fmt.Errorf("请求失败,错误信息:\r\n%v",err)}else{var netReturn map[string]interface{}json.Unmarshal(data,&netReturn)ifnetReturn["error_code"].(float64)==0{fmt.Printf("接口返回result字段是:\r\n%v",net Return["result"])}}}// get 网络请求func Get(apiURL string,params url.Values)(rs[]byte,err error){ var Url *url.URLUrl,err=url.Parse(apiURL)iferr!=nil{fmt.Printf("解析url错误:\r\n%v",err)returnnil,err}//如果参数中有中文参数,这个方法会进行URLEncodeUrl.RawQuery=params.Encode()resp,err:=http.Get(Url.String())iferr!=nil{fmt.Println("err:",err)returnnil,err}defer resp.Body.Close()returnioutil.ReadAll(resp.Body)}// post 网络请求 ,params 是url.Values类型func Post(apiURL string, params url.Values)(rs[]byte,err error){ resp,err:=http.PostForm(apiURL, params)iferr!=nil{returnnil ,err}defer resp.Body.Close()returnioutil.ReadAll(resp.Body) }。

接⼝管理效率神器Apifox前⾔你是⼀个测试，你们团队⽬前开发模式是前后端分离。

某⼀天，版本V1.0接⼝评审完，发布在了swagger上，前后端各⾃进⾏开发。

此时你根据接⼝⽂档将新接⼝迁移到JMeter上，然后开始编写接⼝测试⽤例。

过了⼏天，前端先提测了APP，怎么测试前端效果呢， 你想到使⽤charles抓包，造⼀些假数据，然后改响应数据。

然⽽界⾯情况有点多，数据准备起来有点繁琐。

这时前端同学向你介绍了Mock⼯具Rap，他们把接⼝放在上⾯，编写mock规则，获得模拟数据进⾏前端调试。

虽然数据也不是很真实，但是类型和结构是对了。

⼜过⼏天，后端终于提测，连接到测试服务器上运⾏接⼝⽤例，有个接⼝报错，前端打开价格页也有些显⽰错乱。

你淡定地抓包看数据，查了⼀下接⼝⽂档，原来是后端返回的字段类型错了，于是你在jira上提了bug给后端同学，并有理有据粘贴了⽂档截图和抓包截图。

后端同学过了⼀会跑过来告诉你，”这个字段有变更，我在Postman调试通过的，忘记改⽂档和通知你们啦，⿇烦你转给前端吧。

“后端很⽆辜，前端很⽆奈，你⼼很累，然⽽只能默默改⽤例。

⼜过了⼀段时间，你发现，有些⾃动化⽤例跑不动了，原来是隔了很久，接⼝的变动有些没来得及改，脚本的数据跟⽂档差异变多，看来还要专门找时间检查接⼝的差异。

可是刚好有新⼈⼊职，还要给他培训JMeter的⽤法，看来这周⼜要加班了 。

你有没有想过，这⼀切的⼀切都是因为你的团队没有⽤过⼀个可以同时解决数据同步、调试、Mock、⾃动化测试的。

咦，你问我是什么神器吗，那我就告诉你什么是ApifoxApifox是⼀个集API ⽂档管理、接⼝调试、Mock功能、测试于⼀体的研发协作平台，简单来说Apifox 是 Postman + Swagger + Mock + JMeter的有机结合，整合多种接⼝管理流程，为研发团队提供⼀个开箱即⽤的Api流程管理的可视化⼯具。

为什么选Apifox我们常常讨论敏捷开发、使⽤数字化⼯具实现研发项⽬流程管理。

api接口文档2篇API接口文档是指对某个API接口的详细说明和规范，可以帮助开发人员快速了解和使用该接口。

本文将介绍两篇关于API接口的文档，涉及接口的功能、请求参数、返回参数等内容。

以下是对两篇API 接口文档的详细描述。

第一篇API接口文档接口名称: 用户登录接口接口功能: 用户通过该接口进行登录操作，获取登录凭证请求URL: /api/login请求方法: POST请求参数:- username (string): 用户名，必填字段- password (string): 密码，必填字段返回参数:- code (int): 返回码，0表示成功，其他值表示失败- message (string): 返回结果信息- token (string): 登录凭证，用于后续请求的身份认证备注: 需要传递参数格式为JSON第二篇API接口文档接口名称: 商品列表接口接口功能: 获取商品列表，支持分页和筛选功能请求URL: /api/products请求方法: GET请求参数:- page (int): 当前页码，默认为1- size (int): 每页显示数量，默认为10- keyword (string): 关键词，模糊搜索商品名称- category (string): 商品分类，筛选商品分类返回参数:- code (int): 返回码，0表示成功，其他值表示失败- message (string): 返回结果信息- data (object): 返回的商品列表数据- id (int): 商品ID- name (string): 商品名称- price (float): 商品价格备注: 无需传递参数时，请求URL为/api/products，参数需要拼接在URL后面，如/api/products?page=2&size=20通过以上对两篇API接口文档的介绍，开发人员可以清楚地了解接口的功能、请求方法、请求参数和返回参数等详细信息。

数据仓库服务(DWS) 8.1.3.310API参考文档版本01发布日期2023-03-30版权所有 © 华为云计算技术有限公司 2023。

保留一切权利。

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意您购买的产品、服务或特性等应受华为云计算技术有限公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。

除非合同另有约定，华为云计算技术有限公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。

除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

目录1 使用前必读 (1)1.1 概述 (1)1.2 调用说明 (1)1.3 终端节点 (1)1.4 基本概念 (1)2 API概述 (3)3 如何调用API (5)3.1 构造请求 (5)3.2 认证鉴权 (8)3.3 返回结果 (9)4 快速入门 (11)5 API说明 (17)5.1 集群管理接口 (17)5.1.1 创建集群 (17)5.1.2 查询集群列表 (22)5.1.3 查询集群详情 (29)5.1.4 查询节点类型 (37)5.1.5 删除集群 (39)5.1.6 重启集群 (41)5.1.7 扩容集群 (42)5.1.8 重置密码 (44)5.1.9 集群工作负载管理 (46)5.1.9.1 查询工作负载管理计划列表 (46)5.1.9.2 查询工作负载管理计划 (49)5.1.9.3 切换工作负载计划阶段 (52)5.1.9.4 启动工作负载计划 (53)5.1.9.5 停止工作负载计划 (55)5.2 快照管理接口 (56)5.2.1 创建快照 (56)5.2.2 查询快照列表 (58)5.2.3 查询快照详情 (60)5.2.4 删除手动快照 (63)5.2.5 恢复集群 (64)5.3 数据库监控管理接口 (67)5.3.1 查询DWS集群状态 (67)5.3.2 查询DWS集群中数据库使用情况 (72)5.3.3 查询DWS集群各节点磁盘IO使用情况 (74)5.3.4 查询DWS集群各节点磁盘IO使用情况（聚合类型） (77)5.3.5 查询DWS集群各节点文件系统使用情况 (81)5.3.6 查询DWS集群各节点文件系统使用情况（聚合类型） (83)5.3.7 查询DWS集群节点各网卡流量 (87)5.3.8 查询DWS集群查询执行情况 (90)5.3.9 查询DWS集群会话执行情况 (94)5.3.10 查询DWS硬件资源使用情况 (96)5.3.11 查询DWS集群硬件资源使用情况（聚合类型） (99)6 附录 (103)6.1 状态码 (103)6.2 错误码 (105)6.3 创建VPC (113)6.4 获取资源集ID (113)6.5 获取租户ID (114)6.6 获取集群ID (114)6.7 获取Endpoint (115)1使用前必读1.1 概述欢迎使用数据仓库服务GaussDB(DWS)。

XXAPI接口设计说明书'公司2016年11月25日文档管理信息表【文档变更记录表目录文档变更记录表.......................................... 错误!未定义书签。

目录................................................... 错误!未定义书签。

引言.................................................... 错误!未定义书签。

编写目的 .................................... 错误!未定义书签。

背景 ........................................ 错误!未定义书签。

定义 ........................................ 错误!未定义书签。

参考资料 .................................... 错误!未定义书签。

综述.................................................... 错误!未定义书签。

统一的输入输出参数........................... 错误!未定义书签。

必须登录才能访问的接口....................... 错误!未定义书签。

错误返回码列表 .............................. 错误!未定义书签。

用户接口................................................ 错误!未定义书签。

用户注册（user/signup）...................... 错误!未定义书签。

用户登录（user/signin）...................... 错误!未定义书签。

优惠券接口.............................................. 错误!未定义书签。

前言东软API文档前言前言前言Short Message Internet Access Solution（SMIAS）是结合中国移动通信总公司的“梦网计划”应运而生的一套基于短信的移动互联网应用解决方案。

本系统提供了面向服务提供商（ASP或ICP）的开发接口，服务提供商可以使用这些接口API实现与福建移动通信公司SMIAS系统的接入。

阅读指南阅读指南本部分主要讨论本手册的目标、阅读对象、手册的组织结构。

〖手册目标〗本手册是SMIAS (Short Message Internet Access Solution)短信网关系统SP 接入子系统通信接口C API的使用指南。

它详细介绍了SP-SMIAS网关之间的通信流程，通信协议，以及通信接口C API的数据结构，以及函数调用方法。

SP可以通过本手册的说明，与SMIAS短信网关系统进行正确的通信，以提供服务。

〖阅读对象〗本手册面向的主要对象是准备接入SMIAS短信网关系统的SP的开发人员。

〖手册构成〗本手册由如下章节组成：∙概述对SMIAS系统的总体概述∙通信流程描述了SP接入SMIAS网关的通信流程，以及注意事项∙通信协议以表格的方式描述了SP与SMIAS网关通信的各种通信包的包格式，方便与SP在与SMIAS网关通信时的跟踪调试。

∙ C API使用说明描述了C API的数据结构，数据类型的含义，以及各个接口函数的调用方法。

【注意】的意思是请读者注意那些需要注意的事项。

【警告】的意思是请读者千万注意某些事项，否则将造成错误。

目录目录第1章概述11.1 网关结构 (1)§1.2 消息转发过程 (2)§1.2.1本地消息转发过程 (2)§1.2.2 漫游消息转发过程 (3)第2章接口操作1§2.1 SP连接类型 (1)§2.2 操作类型 (2)§2.2.1 SP到SMIAS的操作类型 (2)§2.2.2 SMIAS网关到SP的操作类型 (2)§2.2.3 双向操作类型 (3)§2.3 不同连接方式对操作的支持 (4)§2.4 SP操作流程 (5)§2.4.1 接收型连接操作流程 (5)§2.4.2 发送型连接操作流程 (6)§2.4.3 发送接收型连接操作流程 (7)第3章通信协议1§3.1 阅读说明 (1)§3.1.1 数据类型 (1)§3.1.2 长度 (1)§3.2 协议包格式 (2)§3.3 消息头格式 (2)§3.4 消息体格式 (3)§3.4.1 Login 消息体 (3)§3.4.2 Login Response消息体 (4)§3.4.3 Logout 消息体 (4)§3.4.4 Logout Response消息体 (4)§3.4.5 Submit 消息体 (5)§3.4.6 Submit Response消息体 (7)§3.4.7 Deliver 消息体 (8)§3.4.8 Deliver Response消息体 (9)§3.4.9 Cancel 消息体 (10)§3.4.10 Cancel Response消息体 (10)§3.4.11 Active消息体 (10)§3.4.12 Active Response消息体 (10)附录1附录一应答状态码表 (1)附录二SMIAS短信网关系统SP接口对CMPP协议的扩展 (3)附录三代码样例 (4)修改总结修改总结前言Short Message Internet Access Solution（SMIAS）是结合中国移动通信总公司的“梦网计划”应运而生的一套基于短信的移动互联网应用解决方案。