com.tencent.devops.notify.constant.NotifyMessageCode.kt Maven / Gradle / Ivy
/*
* Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
*
* A copy of the MIT License is included in this file.
*
*
* Terms of the MIT License:
* ---------------------------------------------------
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of
* the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
* LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
* NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package com.tencent.devops.notify.constant
/**
* 流水线微服务模块请求返回状态码
* 返回码制定规则（0代表成功，为了兼容历史接口的成功状态都是返回0）：
* 1、返回码总长度为7位，
* 2、前2位数字代表系统名称（如21代表平台）
* 3、第3位和第4位数字代表微服务模块（00：common-公共模块 01：process-流水线 02：artifactory-版本仓库 03:dispatch-分发 04：dockerhost-docker机器
* 05:environment-环境 06：experience-版本体验 07：image-镜像 08：log-日志 09：measure-度量 10：monitoring-监控 11：notify-通知
* 12：openapi-开放api接口 13：plugin-插件 14：quality-质量红线 15：repository-代码库 16：scm-软件配置管理 17：support-支撑服务
* 18：ticket-证书凭据 19：project-项目管理 20：store-商店 21： auth-权限 22:sign-签名服务 23:metrics-度量服务 24：external-外部
* 25：prebuild-预建 26: dispatcher-kubernetes 27：buildless 28: lambda 29: stream 30: worker 31: dispatcher-docker
* 32: remotedev 35：misc-杂项）
* 4、最后3位数字代表具体微服务模块下返回给客户端的业务逻辑含义（如001代表系统服务繁忙，建议一个模块一类的返回码按照一定的规则制定）
* 5、系统公共的返回码写在CommonMessageCode这个类里面，具体微服务模块的返回码写在相应模块的常量类里面
*
* @since: 2023-3-20
* @version: $Revision$ $Date$ $LastChangedBy$
*
*/
object NotifyMessageCode {
const val ERROR_NOTIFY_INVALID_TITLE = "2111001" // 通知服务：无效的标题：{0}
const val ERROR_NOTIFY_INVALID_BODY = "2111002" // 通知服务：无效的内容：{0}
const val ERROR_NOTIFY_INVALID_RECEIVERS = "2111003" // 通知服务：无效的接收者：{0}
const val ERROR_NOTIFY_INVALID_NOTIFY_TYPE = "2111004" // 通知服务：无效的通知参数类型：{0}
const val ERROR_NOTIFY_SEND_FAIL = "2111005" // 通知服务：通知发送失败
const val ERROR_NOTIFY_TENCENT_CLOUD_EMAIL_SEND_FAIL = "2111006" // 通知服务：腾讯云邮件通知发送失败 返回错误码{0}
const val BK_CONTROL_MESSAGE_LENGTH = "bkControlMessageLength" // ...(消息长度超{0} 已截断,请控制消息长度)
const val BK_LINE_BREAKS_WILL_ESCAPED = "bkLineBreaksWillEscaped" // (注意: 换行会被转义为\\n)
const val BK_DESIGNATED_APPROVER_APPROVAL = "bkDesignatedApproverApproval" // 指定审批人审批
const val BK_NOTIFY_MESSAGES = "bkNotifyMessages" // 蓝鲸通知消息
}