《开放平台错误自查手册具体错误墨灵》由会员分享，可在线阅读，更多相关《开放平台错误自查手册具体错误墨灵（17页珍藏版）》请在金锄头文库上搜索。
1、淘宝网开放平台错误自查手册本文档针对2.0服务，文档中的2.0的说法是相对已下线的1.0而言的墨灵2010-10-15目录一、错误处理流程概览3二、服务器响应内容透析41.调用成功返回格式42.调用错误返回41)http连接错误42)服务端错误总述43)平台解析错误54)业务处理错误6三、响应格式错误处理91.响应格式格式错误，但数据正确92.响应格式错误，数据也错误10四、平台级错误处理11五、业务级错误处理131.参数错误132.权限控制133.用户不存在134.服务错误15a)服务调用错误15b)服务调用异常15c)远程调用错误15d)Top解析错误15六、返回参数缺失处理161.整个消
2、息体为空或缺少文档中说明的结构体返回。162.缺少fields指定字段返回16七、总结17一、 错误处理流程概览图表 1 错误处理流程从这个错误处理流程可知，在整个错误处理的过程中，一共可以分为3条主要的流程：请求解析异常流程处理，平台级错误处理和业务调用错误处理。当然，这一切处理的最初也是最重要的一步就是：将服务器响应内容保留下来。二、 服务器响应内容透析服务器响应内容，顾名思义就是isv调用top服务得到的响应的内容。这些内容能够最真实的反应出isv请求的问题和服务器当前的情况，也最能够帮助isv找到问题的所在。服务器响应内容一般分为两种：一种是wiki文档中所编写的成功调用所返回的字段，
3、另一种是调用失败的返回的错误相关信息。1. 调用成功返回格式2.0的服务调用成功的响应返回信息相对的规范化了。2.0的响应内容主要也可以分为3层：最外一层是你调用服务的名称所对应的响应标记，如：获取单个商品（taobao.item.get）的响应最外层为item_get_response: ，表示这是获取单个商品的响应；中间一层是返回结构体的标记。如果结构体是单个，那么2.0返回的这一层里面就会是单个的结构，如：获取的单个商品的结构体就是item: ；反之，如果结构体是多个，那么列表也会明显的表示出来，如：搜索商品列表的结构体就会是”items”:“item”: , 。最外层的items表示这
4、是一个商品的列表，后面的item表示列表中的每一个子结构体都是属于商品item的，然后就跟着商品的数据；最内一层就商品的具体字段信息了。2. 调用错误返回当调用发生错误的时候，一般情况下可以分为几大类错误信息的返回：http连接错误、平台解析错误、业务处理错误。这三种类型的错误分别代表了：淘宝服务器、淘宝接入平台、top-api业务，几个层次上出现的问题。1) http连接错误http连接错误是请求通信过程中出现的错误，这类型错误通常由http响应码标记出来。http响应码由三位十进制数字组成，它们出现在由HTTP服务器发送的响应的第一行。响应码分五种类型，由它们的第一位数字表示：1xx：信息
5、，请求收到，继续处理2xx：成功，行为被成功地接受、理解和采纳3xx：重定向，为了完成请求，必须进一步执行的动作4xx：客户端错误，请求包含语法错误或者请求无法实现5xx：服务器错误，服务器不能实现一种明显无效的请求Isv调用top服务最常收到就是200：http请求成功；404：未找到请求的服务；500内部服务器错误等等。如果用户收到的响应码是404，表示用户的网络有问题或者top被和谐了如果用户收到的响应码是500，表示网络是ok的，是top的服务无法响应。2) 服务端错误总述平台解析错误和业务处理错误都是http成功访问到top服务（http响应码返回为200）之后所产生的错信息，他们t
6、op处理isv请求过程中出现的问题。2.0的错误响应信息的最外层为“error_response”:” ”，表示这是调用服务失败所返回的错误信息。信息体里面一层总共包含了五个元素：args:arg:“key”:“ ”,”value”:” ”,“key”:“ ”,”value”:” ”,“key”:“ ”,”value”:” ”，”code”:” ”， “msg”:” ”，”sub_code”:” ”和”sub_msg”:” ”。args表示用户传入的参数列表是什么，里面是一个arg的列表会包含用户传入的所有参数信息，每个arg表示一个参数的信息，key表示参数的名称，value表示参数的内容，
7、用以方便用户定位自己的错误；code表示用户调用错误的错误码是多少，小于200表示平台级错误，200-1000之间表示大范围的业务错误，即哪一类型的api调用发生了错误（根据api的大类来分，如：商品类的api是530，交易类的api是520，等）；msg表示大类型的错误码所对应的错误信息，一般不具备独立的debug作用，需要和sub_code和sub_msg一起使用才行；sub_code是调用错误的子错误码，他表示用户调用错误的原因；sub_msg是子错误码所对应的错误信息，他用来补充细化子错误码的错误原因的。例如调用2.0的taobao.item.get服务错误时返回的错误信息：error
8、_response:args:arg:key:app_key,value:15739,key:fields,value:list_time,delist_time,approve_status,key:format,value:json,key:method,value:taobao.item.get,key:nick,value:tbtest561,key:partner_id,value:TOPTEST,key:sign,value:668FB4A049F71A1C845EF8C05B1F3E66,key:timestamp,value:2010-03-05 18:03:06.325,ke
9、y:v,value:2.0,code:530,msg:Remote service error,sub_code:missing-parameter,sub_msg:iid和num_iid至少要传入一个这个信息的开头为error_response，表示这是调用错误所返回的错误信息。里面的args列出了用调用这个接口传入的信息有：key:app_key,value:15739,key:fields,value:list_time,delist_time,approve_status,key:format,value:json,key:method,value:taobao.item.get,ke
10、y:nick,value:tbtest561,key:partner_id,value:TOPTEST,key:sign,value:668FB4A049F71A1C845EF8C05B1F3E66,key:timestamp,value:2010-03-05 18:03:06.325,key:v,value:2.0这些信息是从用户的请求信息里面解析出来的。错误码code为530，表示这是调用商品的api所产生的错误。错误信息msg为Remote service error表示这是调用业务处理所产生的错误。子错误码sub_code为：missing-parameter，表示这个错误是因为缺少了
11、参数所产生的。子错误信息sub_msg为：iid和num_iid至少要传入一个，表示少传的参数为iid或num_iid。这所有的错误信息叠加起来可以知道，这个错误是用户调用taobao.item.get接口时业务处理发现用户没有传入商品id所导致的。3) 平台解析错误平台解析错误是指top返回的错误码小于100的情况。平台解析是非业务性的普适的校验接入层，主要用于对用户的各种权限、和入参进行最基本的校验。现在的平台错误码主要有：错误码 错误描述（英文） 错误描述（中文） 错误来源3Upload Fail 图片上传失败 平台本身4User Call Limited 用户调用次数超限 ISV5Se
12、ssion Call Limited 会话调用次数超限 ISV6Partner Call Limited 合作伙伴调用次数超限 ISV7App Call Limited 应用调用次数超限 ISV8App Call Exceeds Limited Frequency 应用调用频率超限 ISV9Http Action Not Allowed HTTP方法被禁止（请用大写的POST或GET） ISV10Service Currently Unavailable 服务不可用 平台本身11Insufficient ISV Permissions 开发者权限不足 ISV12Insufficient Use
13、r Permissions 用户权限不足 ISV13Insufficient Partner Permissions 合作伙伴权限不足 ISV15Remote Service Error 远程服务出错 平台本身21Missing Method 缺少方法名参数 平台本身22Invalid Method 不存在的方法名 ISV23Invalid Format 非法数据格式 ISV24Missing Signature 缺少签名参数 ISV25Invalid Signature 非法签名 ISV26Missing Session 缺少SessionKey参数 平台本身27Invalid Sessio
14、n 非法的SessionKey参数 ISV28Missing App Key 缺少AppKey参数 平台本身29Invalid App Key 非法的AppKey参数 ISV30Missing Timestamp 缺少时间戳参数 平台本身31Invalid Timestamp 非法的时间戳参数 ISV32Missing Version 缺少版本参数 平台本身33Invalid Version 非法的版本参数 ISV34Unsupported Version 不支持的版本号 ISV40Missing Required Arguments 缺少必选参数 平台本身41Invalid Arguments 非法的参数 ISV42Forbidden Request 请求被禁止 ISV43Parameter Error 参数错误 ISV 图表 2 平台错误码列表Isv可以通过错误码和解释来纠正问题。如：错误码为
