华为云首页用户手册

APPCUBE-如何开放API接口:如何使用错误码

时间：2023-11-01 16:19:13

APPCUBE

如何使用错误码

系统支持对错误码信息进行多语言国际化配置。您可以通过配置错误码，实现根据用户使用的语言不同将错误码信息进行不同的展示。

自定义错误码。

在App视图下左侧菜单栏下方选择“配置”，在打开的页签选择“自定义错误码”。
配置“显示名称”，该名称将会显示在运营配置页签。
单击“新建”。
您也可单击“导入”，选择系统中已创建的错误码进行导入。

参照表7配置错误码参数，单击“保存”。

图7 新建错误码

表7 错误码参数说明
参数	参数说明
名称	客户自定义的错误码。建议以字母打头。包括命名空间，长度不超过64个字节。系统根据“名称”和“语言”匹配错误码进行展示。请保证“名称”+“语言”唯一。
类别	该错误码所属的分类。
Http状态码	Http协议状态码。
语言	请根据实际情况从下拉列表中选择语言类型。目前支持中文、英文、西班牙语、法语和缅甸语。单击“新增”支持创建多语言错误码。单击语言后的“？”显示：请在翻译工作台中添加支持的语言。单击“翻译工作台”可跳转至翻译工作台配置页面。
格式	错误码信息描述。在描述中，可以用{Number}表示变量名。例如 {0} 表示第一个输出变量，{1} 表示第二个输出变量，以此类推。长度不超过255个字节。

创建脚本。

在脚本中调用抛出错误信息的error函数I18nError('ErrorCodeName','变量1','变量2')。该函数中输入参数为错误码名称"t__testErrorCode"和错误码信息中所携带的变量（"val1"和"val2"）。

// test custom error func , get diff language error by user langimport * as error from 'error';export class TestDemo {    @action.method({ label: 'test', description: 'error code', input: 'No input', output: 'No output' })    public test() {        //使用I18nError函数设定错误码和错误码信息携带变量         throw new error.I18nError('t__testErrorCode', ["val1", "val2"]);    }}