文档中心 > 店铺动态卡片-开发指引

错误信息配置使用文档

更新时间:2023/02/10 访问次数:6658

出于对消费者友好提示的考虑,开发者可以选择进行动态错误页映射的配置,由平台来统一进行异常页的跳转。

注意:错误页配置请配置到接口级别,最好不要配置全局的。 在打开新页面获取必要数据时,给对应的接口配置上错误码兜底页,其他情况下(比如页面已经打开,在页面内操作),建议isv自行处理错误,采用友好弹框的方式处理。

 

动态错误页的配置包括对平台通用错误码自定义错误码的配置。平台错误码可根据下拉列表进行选择;自定义错误码需要按照平台标准格式进行返回回格式中的errorCode字段值相同,配置才生效。配置生效后,云SDK会处理错误跳转到本次配置的错误页。目前可配置的错误页包括:App版本太低和网络异常页。

云SDK版本 >= 1.4.2,支持淘宝和天猫客户端,千牛端(包括PC和移动端)暂不支持。


   image                     image                        

一、云函数

 

用户对云函数错误的配置包括两种情况:

1)普通云函数业务错误;

在控制台选择平台通用错误,错误码为云函数通用业务异常;


2)云函数错误返回标准;

用户也可以按照以下格式给予云函数统一的错误返回标准。此时用户需要在控制台选择自定义错误码,配置的错误码为errorCode字段值


用户如果想对云函数进行动态错误页配置,配置步骤如下:


1)在云函数的选项中选择错误页配置,可以查看当前环境下已经配置的错误页信息。


image


2)如果要查看其他环境下错误页的配置信息,可以切换环境。


image


3)点击添加按钮,弹出框会列出当前部署的函数名以及其相对应的handler,用户可以配置相应的平台错误码或者自定义的错误码,以及本次要跳转的错误页,添加完成后,该配置状态为启用中,云SDK会根据用户配置的错误帮忙跳转到相应页面。


注:在云函数错误页配置中,函数名和handler可以配置成匹配全部,代表配置对所有函数和handler生效。也可以单独配置函数名,对该函数下所有的。

                   

     handler生效

image


4)在所有已启动的配置中,错误页按最细的服务粒度(先级最高的配置)进行跳转。

例如在下图已启的配置中,优先级顺序为:

指定函数&指定handler > 指定函数&全部handler > 全部函数&全部handler

 

最终云SDK会处理错误跳转到本次最高优先级配置的错误页,即这里的App版本太低。


image


5)用户可以修改每条错误页的配置状态,对已启用的配置禁用、删除等,禁用后的配置不再生效。

image

 

二、云应用

 

用户对云应用错误返回标准遵循平台提供的统一调用格式。用户需要配置的自定义错误码为errorCode字段值才生效。


云应用的错误页配置过程与云函数类似。

用户在云应用的选项中选择错误页配置,可以查看当前环境下已经配置的错误页信息。

 

image


注:添加云应用错误码配置时,应用名称为必填项,服务路径为*时,匹配全部路径。

优先级顺序为:配置具体服务路径 > *。


image

 

 

FAQ

关于此文档暂时还没有FAQ
返回
顶部