错误响应
<p>[TOC]</p>
<h2>说明</h2>
<p>接口调用失败会返回相应的错误响应:</p>
<table>
<thead>
<tr>
<th style="text-align: left;">字段名</th>
<th style="text-align: left;">类型 </th>
<th style="text-align: left;">字段说明 </th>
<th style="text-align: left;">示例值 </th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">code </td>
<td style="text-align: left;">Integer </td>
<td style="text-align: left;">错误码 </td>
<td style="text-align: left;">40100 </td>
</tr>
<tr>
<td style="text-align: left;">msg </td>
<td style="text-align: left;">String </td>
<td style="text-align: left;">错误消息 </td>
<td style="text-align: left;">无授权 ID</td>
</tr>
<tr>
<td style="text-align: left;">traceId</td>
<td style="text-align: left;">String </td>
<td style="text-align: left;">链路追踪 ID,帮助排查请求接口问题</td>
<td style="text-align: left;">74ce3525-7698-4f6a-8e12-481794384987</td>
</tr>
</tbody>
</table>
<h3><code>traceId</code></h3>
<p>当客户端无法定位错误原因时,请联系我们并提供当前错误响应中的 <code>traceId</code> 值,该值可以帮助我们快速定位排查当前请求发生错误的原因。</p>
<h3>错误响应示例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 40103,
&quot;msg&quot;: &quot;无效的授权令牌&quot;,
&quot;traceId&quot;: &quot;5fcc7ea5-89e1-4ffd-a614-3cc5af3b8070&quot;
}</code></pre>
<h2>错误响应分类</h2>
<h3>鉴权相关</h3>
<table>
<thead>
<tr>
<th>值 </th>
<th>描述 </th>
<th>建议 </th>
</tr>
</thead>
<tbody>
<tr>
<td>40100 </td>
<td>无授权 ID </td>
<td>检查请求 <code>Header</code> 是否存在 <code>Auth-Id</code> </td>
</tr>
<tr>
<td>40101 </td>
<td>无授权令牌 </td>
<td>检查请求 <code>Header</code> 是否存在 <code>Authorization</code> </td>
</tr>
<tr>
<td>40102 </td>
<td>无效的授权 ID </td>
<td>检查授权 ID 是否正确 </td>
</tr>
<tr>
<td>40103 </td>
<td>无效的授权令牌 </td>
<td>检查授权 Token 是否正确 </td>
</tr>
<tr>
<td>40104 </td>
<td>不合法的接入分销商 </td>
<td>检查请求 IP 地址是否合法,[IP 地址说明](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10917921809954971">https://www.showdoc.com.cn/gatewaypartnerv1/10917921809954971</a> "IP 地址说明") </td>
</tr>
<tr>
<td>40105 </td>
<td>请求过于频繁 </td>
<td>触发频控限制,请降低并发量并稍后重试 </td>
</tr>
</tbody>
</table>
<h3>业务相关</h3>
<table>
<thead>
<tr>
<th>值 </th>
<th>描述 </th>
<th>建议 </th>
</tr>
</thead>
<tbody>
<tr>
<td>40001 </td>
<td>参数错误 </td>
<td>对照查看 API 文档,检查请求参数 </td>
</tr>
<tr>
<td>40002 </td>
<td>没有权限进行相关操作 </td>
<td>检查请求参数值 </td>
</tr>
<tr>
<td>40003 </td>
<td>参数校验失败 </td>
<td>根据接口返回消息描述,检查参数值 </td>
</tr>
<tr>
<td>40099 </td>
<td>业务错误 </td>
<td>联系客服并提供链路追踪 ID,排查问题 </td>
</tr>
<tr>
<td>50000 </td>
<td>系统错误 </td>
<td>联系客服并提供链路追踪 ID,排查问题 </td>
</tr>
</tbody>
</table>