获取消息通知配置列表 - ListNoticeConfigsByProjectId

功能介绍

根据工程唯一标识获取消息通知配置列表

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/notice_config/notice_config_list

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及取值范围: 项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字默认取值: 不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
code	String	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
error	CommonResponseErrorListNoticeConfig object	参数解释统一错误返回取值范围不涉及
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串
result	Array of NoticeConfig objects	参数解释结果取值范围不涉及
status	String	参数解释 '状态值，如success、error' 取值范围 success，请求成功 error，请求报错

表4 CommonResponseErrorListNoticeConfig
参数	参数类型	描述
code	String	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
detail	Array of NoticeConfig objects	参数解释错误信息详情取值范围不涉及
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串

表5 NoticeConfig
参数	参数类型	描述
create_time	String	参数解释创建时间(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
create_time_stamp	Long	参数解释创建时间戳(单位：毫秒) 取值范围不涉及
create_time_string	String	参数解释创建时间字符串(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
create_user	String	参数解释创建者取值范围不超过255个字符组成的字符串
id	String	参数解释唯一标识取值范围 32个字符组成的字符串
name	String	参数解释名称取值范围不超过300个字符组成的字符串
project_id	String	参数解释工程唯一标识取值范围 32个字符组成的字符串
region	String	参数解释区域名称取值范围不超过32个字符组成的字符串
send_email	Boolean	是否发送邮件,y：发送，n：不发送
send_message	Boolean	是否发送服务动态,y：发送，n：不发送
source_type	String	该字段由于用例信息调用接口转换需要，值暂时写死不删除，后测试计划修改完成后方可删除
type	String	消息通知类型 0,测试用例执行完成 1,测试套件执行完成
update_time	String	参数解释更新时间(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
update_time_stamp	Long	参数解释更新时间戳(单位：毫秒) 取值范围不涉及
update_time_string	String	参数解释更新时间字符串(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
update_user	String	参数解释更新者取值范围不超过32个字符组成的字符串

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

请求示例

get https://{endpoint}/v1/5b17edd8ee504023aad7a496b116dff8/notice_config/notice_config_list?source_type=1

响应示例

状态码：200

{
  "status" : "ok",
  "result" : [ {
    "id" : "1a8f24fca54d4972abe259b00c2db049",
    "name" : "接口测试用例执行完成",
    "type" : "0",
    "region" : null,
    "create_user" : "CloudTest-0704",
    "create_time" : "2025-06-12T07:49:18+0800",
    "update_user" : "CloudTest-0704",
    "update_time" : "2025-06-12T07:49:18+0800",
    "send_message" : false,
    "send_email" : false,
    "project_id" : "5b17edd8ee504023aad7a496b116dff8",
    "source_type" : "1"
  }, {
    "id" : "3f2db2bca83248d8a4a29ad05c3bd1ef",
    "name" : "测试套件执行完成",
    "type" : "1",
    "region" : null,
    "create_user" : "CloudTest-0704",
    "create_time" : "2025-06-12T07:49:18+0800",
    "update_user" : "CloudTest-0704",
    "update_time" : "2025-06-12T07:49:18+0800",
    "send_message" : false,
    "send_email" : false,
    "project_id" : "5b17edd8ee504023aad7a496b116dff8",
    "source_type" : "1"
  } ],
  "reason" : null,
  "error" : null,
  "code" : null
}