CommonErrorCodeEnum

epmet-openapi/epmet-openapi-scan/src/main/java/com/epmet/openapi/scan/common/enu/CommonErrorCodeEnum.java

@@ -0,0 +1,68 @@
+package com.epmet.openapi.scan.common.enu;
+
+import com.epmet.commons.tools.constant.StrConstant;
+
+/**
+ * 公共错误码
+ *
+ * @author yinzuomei@elink-cn.com
+ * @date 2021/1/10 19:43
+ */
+public enum CommonErrorCodeEnum {
+    OK(200, "请求成功。"),
+    PROCESSING(280, "任务正在执行中，建议您等待一段时间（例如5s）后再查询结果。"),
+    BAD_REQUEST(400, "请求有误，通常由于请求参数不正确导致，请仔细检查请求参数。"),
+    NOT_ALLOWED(401, "请求失败，通常是由于使用了不安全的图片、视频、语音链接地址。"),
+    FORBIDDEN(403, "请求访问失败，通常由于您的图片、视频、语音链接无法访问导致，请确认公网是否可访问，并且无防盗链策略。"),
+    NOT_FOUND(404, "待检测内容未找到，通常是由于您的图片、视频、语音内容无法下载导致，请确认内容可通过公网访问到。"),
+    DOWNLOAD_FAILED(480, "下载失败，请确认待检测内容的大小、分辨率（如果有）在API的限制范围内。"),
+    GENERAL_ERROR(500, "一般是服务端临时出错。建议重试，若持续返回该错误码，请通过工单联系我们。"),
+    DB_FAILED(580, "数据库操作失败。建议重试，若持续返回该错误码，请通过工单联系我们。"),
+    TIMEOUT(581, "超时。建议重试，若持续返回该错误码，请通过工单联系我们。"),
+    CACHE_FAILED(585, "缓存出错。建议重试，若持续返回该错误码，请通过工单联系我们。"),
+    ALGO_FAILED(586, "算法出错。请通过工单联系我们。"),
+    MQ_FAILED(587, "中间件出错。请通过工单联系我们。"),
+    EXCEED_QUOTA(588, "请求频率超出配额。默认配额：图片检测50张/秒，视频检测20路/秒，语音检测20路/秒，文本检测100条/秒。如果需要调整配额，请通过工单联系我们。"),
+    TOO_LARGE(589, "待检测内容过大，请确保检测的内容在API的限制范围内。建议重试，若持续返回该错误码，请通过工单联系我们。"),
+    BAD_FORMAT(590, "待检测内容格式错误，请确保检测的内容在API的限制范围内。"),
+    CONNECTION_POOL_FULL(591, "连接池满。请通过工单联系我们。"),
+    DOWNLOAD_TIMEOUT(592, "下载超时，下载时间限制为3s，请确保检测的内容大小在API的限制范围内。"),
+    EXPIRED(594, "任务过期，如taskId过期。"),
+    CATCH_FRAME_FAILED(595, "截帧失败，请通过工单联系我们。"),
+    PERMISSION_DENY(596, "账号未授权、账号欠费、账号未开通、账号被禁等原因，具体可以参考返回的msg。");
+
+
+    private Integer code;
+    private String desc;
+
+    CommonErrorCodeEnum(Integer code, String desc) {
+        this.code = code;
+        this.desc = desc;
+    }
+
+    public Integer getCode() {
+        return code;
+    }
+
+    public void setCode(Integer code) {
+        this.code = code;
+    }
+
+    public String getDesc() {
+        return desc;
+    }
+
+    public void setDesc(String desc) {
+        this.desc = desc;
+    }
+
+    public static String getErrorMsg(Integer value) {
+        CommonErrorCodeEnum[] codeEnums = values();
+        for (CommonErrorCodeEnum commonErrorCodeEnum : codeEnums) {
+            if (commonErrorCodeEnum.getCode().equals(value)) {
+                return commonErrorCodeEnum.getDesc();
+            }
+        }
+        return StrConstant.EPMETY_STR;
+    }
+}