修改事件通知配置 - UpdateMessageNoticesConfigs
功能介绍
此接口用于根据事件类型,修改是否发送服务动态/发送邮件的配置,对应页面 测试 -> 测试设置 -> 消息通知
调用方法
请参见如何调用API。
URI
PUT /v4/projects/{project_id}/message-notices
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
通知id |
|
name |
否 |
String |
通知配置名称 |
|
type |
是 |
Integer |
参数解释: 消息类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
send_email |
是 |
Boolean |
是否发送邮件 |
|
send_message |
是 |
Boolean |
是否发送动态 |
|
project_id |
否 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
|
notice_users |
否 |
Array of NameAndIdVo objects |
通知用户 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 调用此接口的响应状态。 取值范围:
|
|
result |
ResultValueString object |
请求返回的数据 |
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入，建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
String |
实际的数据类型：单个对象，集合 或 NULL |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
分页大小 |
|
page_no |
Integer |
分页编码 |
|
has_more |
Boolean |
是否有更多 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
请求示例
put https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154}/message-notices
{
"project_id" : "407ac57de7ea44d28e47293a2b9cf15c",
"id" : "deleteCata",
"name" : "删除目录",
"send_email" : true,
"send_message" : true,
"type" : 0
}
响应示例
状态码：200
OK
{
"value" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
