淘宝开放平台错误码---自查手册

淘宝网

开放平台错误自查手册

本文档针对2.0服务，1.0请酌情参考

2010-11-8

杭州

目录

一、错误处理流程概览 (2)

二、服务器响应内容透析 (3)

1.调用成功返回格式 (4)

2.调用错误返回 (4)

1)http连接错误 (4)

2)服务端错误总述 (4)

3)平台解析错误 (5)

4)业务处理错误 (6)

三、响应格式错误处理 (10)

1.响应格式格式错误，但数据正确 (11)

2.响应格式错误，数据也错误 (12)

四、平台级错误处理 (12)

五、业务级错误处理 (14)

1.参数错误 (14)

2.权限控制 (15)

3.用户不存在 (15)

4.服务错误 (16)

a)服务调用错误 (16)

b)服务调用异常 (17)

c)远程调用错误 (17)

d)Top解析错误 (17)

六、返回参数缺失处理 (17)

1.整个消息体为空或缺少文档中说明的结构体返回。 (17)

2.缺少fields指定字段返回 (18)

七、总结 (18)

一、错误处理流程概览

从这个错误处理流程可知，在整个错误处理的过程中，一共可以分为3条主要的流程：请求解析异常流程处理，平台级错误处理和业务调用错误处理。当然，这一切处理的最初也是最重要的一步就是：将服务器响应内容保留下来。

二、服务器响应内容透析

服务器响应内容，顾名思义就是isv调用top服务得到的响应的内容。这些内容能够最真实的反应出isv请求的问题和服务器当前的情况，也最能够帮助isv找到问题的所在。

服务器响应内容一般分为两种：一种是wiki文档中所编写的成功调用所返回的字段，

另一种是调用失败的返回的错误相关信息。

1.调用成功返回格式

调用成功的响应信息内容根据调用服务版本的不同分为了两种不同的格式。

1.0的服务返回信息的格式分为三层：最外一层是"rsp":{ }标记，表示这是服务的响应内容；中间一层是返回结构体的标记，如：返回的是商品的结构体，中间这层就是"items":[{ },{ }……]，表示结果是一个商品的列表，如果返回参数不是以结构体的形式，这一层就不存在；最内一层就是每个结构体具体的字段了。1.0这个版本所有返回结果，不论是单个的商品还是一个商品列表，他的第二层都是一个列表的结构，区别只是列表里有一个子结构体还是有多个子结构体而已。

相比之下，2.0的服务返回信息就相对的规范化了。2.0的响应内容主要也可以分为3层：最外一层是你调用服务的名称所对应的响应标记，如：获取单个商品（taobao.item.get）的响应最外层为"item_get_response":{ }，表示这是获取单个商品的响应；中间一层是返回结构体的标记。如果结构体是单个，那么2.0返回的这一层里面就会是单个的结构，如：获取的单个商品的结构体就是"item":{ }；反之，如果结构体是多个，那么列表也会明显的表示出来，如：搜索商品列表的结构体就会是”items”:{“item”:[{ },{ }……]}。最外层的items表示这是一个商品的列表，后面的item表示列表中的每一个子结构体都是属于商品item的，然后就跟着商品的数据；最内一层就商品的具体字段信息了。

2.调用错误返回

当调用发生错误的时候，一般情况下可以分为几大类错误信息的返回：http连接错误、平台解析错误、业务处理错误。这三种类型的错误分别代表了：淘宝服务器、淘宝接入平台、top-api业务，几个层次上出现的问题。

1)http连接错误

http连接错误是请求通信过程中出现的错误，这类型错误通常由http响应码标记出来。http响应码由三位十进制数字组成，它们出现在由HTTP服务器发送的响应的第一行。

响应码分五种类型，由它们的第一位数字表示：

1xx：信息，请求收到，继续处理

2xx：成功，行为被成功地接受、理解和采纳

3xx：重定向，为了完成请求，必须进一步执行的动作

4xx：客户端错误，请求包含语法错误或者请求无法实现

5xx：服务器错误，服务器不能实现一种明显无效的请求

Isv调用top服务最常收到就是200：http请求成功；404：未找到请求的服务；500内部服务器错误等等。如果用户收到的响应码是404，表示用户的网络有问题或者top被和谐了……如果用户收到的响应码是500，表示网络是ok的，是top的服务无法响应。

2)服务端错误总述

平台解析错误和业务处理错误都是http成功访问到top服务（http响应码返回为200）之后所产生的错信息，他们top处理isv请求过程中出现的问题。1.0和2.0的格式有所不同。

1.0的错误响应信息最外层为{“error_rsp”:{ }},表示这是调用错误所返回的信息。里面一层包含两个元素：”code”:””和“msg”:””，前者表示错误码是多少，后者表示错误信息是什

么。例如错误的调用1.0的taobao.item.get服务错误时返回的错误信息：

{"error_rsp":{"code":40,"msg":"Missing required arguments:missing parameter iid/num_iid"}}。这个信息的开头为error_rsp，表示这是调用错误所返回的结果。里面包含的错误体的code 为40，是平台型错误，表示错误是缺少了必传参数所引起的。然后msg内容为Missing required arguments:missing parameter iid/num_iid，表示缺少的必传参数是iid或者num_iid。Isv解析到这些信息后就需要根据错误信息改进自己传入的参数来使调用成功。

2.0的错误响应信息的最外层为{“error_response”:””}，表示这是调用服务失败所返回的错误信息。信息体里面一层总共包含了五个元素："args":{"arg":[{“key”:“”,”value”:””},{“key”:“”,”value”:””},{“key”:“”,”value”:””}……]}，”code”:””，“msg”:””，”sub_code”:””和”sub_msg”:””。args表示用户传入的参数列表是什么，里面是一个arg的列表会包含用户传入的所有参数信息，每个arg表示一个参数的信息，key表示参数的名称，value表示参数的内容，用以方便用户定位自己的错误；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_response":{"args":{"arg":[{"key":"app_key","value":"15739"},{"key":"fields","value":"list_ time,delist_time,approve_status"},{"key":"format","value":"json"},{"key":"method","value":"taob ao.item.get"},{"key":"nick","value":"tbtest561"},{"key":"partner_id","value":"TOPTEST"},{"key":"s ign","value":"668FB4A049F71A1C845EF8C05B1F3E66"},{"key":"timestamp","value":"2010-03-05 18:03:06.325"},{"key":"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"},{"key":"nick","value ":"tbtest561"},{"key":"partner_id","value":"TOPTEST"},{"key":"sign","value":"668FB4A049F71A1C 845EF8C05B1F3E66"},{"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，表示这个错误是因为缺少了参数所产生的。子错误信息sub_msg为：iid和num_iid至少要传入一个，表示少传的参数为iid或num_iid。这所有的错误信息叠加起来可以知道，这个错误是用户调用taobao.item.get接口时业务处理发现用户没有传入商品id所导致的。

3)平台解析错误

平台解析错误是指top返回的错误码小于100的情况。平台解析是非业务性的普适的校验接入层，主要用于对用户的各种权限、和入参进行最基本的校验。现在的平台错误码主要有：