获取消息通知配置列表 - ListNoticeConfigsByProjectId
功能介绍
根据工程唯一标识获取消息通知配置列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/notice_config/notice_config_list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
error |
统一错误返回 |
|
|
reason |
String |
失败原因 |
|
result |
Array of NoticeConfig objects |
结果 |
|
status |
String |
状态
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
detail |
Array of NoticeConfig objects |
错误信息详情 |
|
reason |
String |
错误原因 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_time |
String |
创建时间 |
|
create_time_stamp |
Long |
创建时间戳 |
|
create_time_string |
String |
创建时间字符串 |
|
create_user |
String |
创建人 |
|
id |
String |
唯一标识 |
|
name |
String |
名称 |
|
project_id |
String |
工程唯一标识 |
|
region |
String |
区域名称 |
|
send_email |
Boolean |
是否发送邮件,y：发送，n：不发送 |
|
send_message |
Boolean |
是否发送服务动态,y：发送，n：不发送 |
|
source_type |
String |
该字段由于用例信息调用接口转换需要，值暂时写死不删除，后测试计划修改完成后方可删除 |
|
type |
String |
消息通知类型
|
|
update_time |
String |
更新时间 |
|
update_time_stamp |
Long |
更新时间戳 |
|
update_time_string |
String |
更新时间字符串 |
|
update_user |
String |
更新人 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
请求示例
get https://{endpoint}/v1/5b17edd8ee504023aad7a496b116dff8/notice_config/notice_config_list?source_type=1
响应示例
状态码：200
OK
{
"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
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
