6.1 关键操作通知管理
6.1.2 修改关键操作通知
"operation_type" : "customized", "operations" : [ {
"resource_type" : "tracker", "service_type" : "CTS",
"trace_names" : [ "createTracker", "deleteTraceker" ] }, {
"resource_type" : "notification", "service_type" : "CTS",
"trace_names" : [ "deleteNotification", "updateNotification" ] }, {
"resource_type" : "pe", "service_type" : "AOM",
"trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ] } ],
"project_id" : "24edf66e79d04187acb99a463e610764", "status" : "enabled",
"topic_id" : "urn:smn:cn-north-7:24edf66e79d04187acb99a463e610764:test"
}
您可以在API Explorer中调试该接口。
URI
PUT /v3/{project_id}/notifications
表6-9 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,参见《云审计服务API 参考》“获取账号ID和项目ID” 自定义类型(customized)。 完 整类型下,CTS发送通知的对象
● customized
● complete operations 否 Array of
Operations sers objects
通知用户列表,目前最多支持对 10个用户组和50个用户发起的 操作进行配置。
status 是 String 标识关键操作通知状态,包括正
常(enabled),停止(disabled)两 种状态。
枚举值:
● enabled
● disabled
参数 是否必选 参数类型 描述
topic_id 否 String 消息通知服务的topic_urn或者 函数工作流的func_urn,当
“status”字段为enabled时,
该字段必填。
● 消息通知服务的topic_urn可 以通过消息通知服务的查询 主题列表API获取,示例:
urn:smn:regionId:f96188c7c caf4ffba0c9aa149ab2bd57:t est_topic_v2。
● 函数工作流的func_urn可以 通过函数工作流的获取函数 列表API获取,示例:
urn:fss:xxxxxxxxx:
7aad83af3e8d42e99ac194e 8419e2c9b:function:default:
test。
notification_id 是 String 关键操作通知id
表6-11 Operations
参数 是否必选 参数类型 描述
service_type 是 String 标识云服务类型。必须为已对接 CTS的云服务的英文缩写,且服 务类型一般为大写字母。 已对 接的云服务列表参见《云审计服 务用户指南》“支持的服务”章 节。
resource_type 是 String 标识资源类型。
trace_names 是 Array of
strings 标识事件名称。
表6-12 NotificationUsers
参数 是否必选 参数类型 描述
user_group 是 String IAM用户组。
user_list 是 Array of
strings IAM用户。
响应参数
状态码: 200
表6-13 响应 Body 参数
参数 参数类型 描述
notification_n
ame String 标识关键操作名称。
operation_typ
e String 标识操作类型。 目前支持的操作类型有完整类型
(complete)和自定义类型(customized)。 完整类 型下,CTS发送通知的对象为已对接服务的所有 事件。 自定义类型下,CTS发送通知的对象是在 operations列表中指定的事件。
枚举值:
● customized
● complete operations Array of
Operations sers objects
通知用户列表,目前最多支持对10个用户组和50 个用户发起的操作进行配置。
status String 标识关键操作通知状态,包括正常(enabled),停 止(disabled)两种状态。
枚举值:
● enabled
● disabled
topic_id String 消息通知服务的topic_urn或者函数工作流的 func_urn。
● 消息通知服务的topic_urn可以通过消息通知服 务的查询主题列表API获取,示例:
urn:smn:regionId:f96188c7ccaf4ffba0c9aa14 9ab2bd57:test_topic_v2。
● 函数工作流的func_urn可以通过函数工作流的 获取函数列表API获取,示例:
urn:fss:xxxxxxxxx:
7aad83af3e8d42e99ac194e8419e2c9b:functi on:default:test。
notification_id String 关键操作通知的唯一标识。
参数 参数类型 描述 notification_ty
pe String 关键操作通知类型,根据topic_id区分为消息通知 服务(smn)和函数工作流(fun)。
枚举值:
● smn
● fun project_id String 项目ID。
create_time Long 关键操作通知创建时间戳。
表6-14 Operations
参数 参数类型 描述
service_type String 标识云服务类型。必须为已对接CTS的云服务的 英文缩写,且服务类型一般为大写字母。 已对接 的云服务列表参见《云审计服务用户指南》“支 持的服务”章节。
resource_type String 标识资源类型。
trace_names Array of
strings 标识事件名称。
表6-15 NotificationUsers
参数 参数类型 描述
user_group String IAM用户组。
user_list Array of
strings IAM用户。
状态码: 400
表6-16 响应 Body 参数
参数 参数类型 描述
error_code String 错误码标识,CTS.XXX。
error_msg String 错误描述。
请求示例
修改关键操作通知请求样例。
PUT https://{endpoint}/v3/{project_id}/notifications
{ "notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8", "notification_name" : "keyOperate_info_cfwy",
"operation_type" : "customized", "operations" : [ {
"service_type" : "CTS", "resource_type" : "tracker",
"trace_names" : [ "createTracker", "deleteTraceker" ] }, {
"service_type" : "CTS", "resource_type" : "notification",
"trace_names" : [ "deleteNotification", "updateNotification" ] }, {
"service_type" : "AOM", "resource_type" : "pe",
"trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ] } ],
"notify_user_list" : [ { "user_group" : "admin", "user_list" : [ "test", "test1" ] }, {
"user_group" : "CTS view", "user_list" : [ "test2", "test3" ] } ],
"status" : "enabled",
"topic_id" : "urn:smn:cn-north-7:24edf66e79d04187acb99a463e610764:foo"
}
响应示例
状态码: 200
修改关键操作通知成功。
{ "notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8", "notification_name" : "keyOperate_info_cfwy",
"operation_type" : "customized", "operations" : [ {
"service_type" : "CTS", "resource_type" : "tracker",
"trace_names" : [ "createTracker", "deleteTraceker" ] }, {
"service_type" : "CTS", "resource_type" : "notification",
"trace_names" : [ "deleteNotification", "updateNotification" ] }, {
"service_type" : "AOM", "resource_type" : "pe",
"trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ] } ],
"notify_user_list" : [ { "user_group" : "admin", "user_list" : [ "test", "test1" ] }, {
"user_group" : "CTS view", "user_list" : [ "test2", "test3" ] } ],
"status" : "enabled",
"project_id" : "24edf66e79d04187acb99a463e610764", "notification_type" : "smn",
"create_time" : 1634001495876,
"topic_id" : "urn:smn:cn-north-7:24edf66e79d04187acb99a463e610764:foo"
}
状态码
状态码 描述
200 修改关键操作通知成功。
400 服务器未能处理请求。
401 请求鉴权校验失败,访问被拒绝。
403 请求权限校验失败,访问被禁止。
404 服务器无法找到被请求的资源或部分关键操作通知删除失败。
500 服务内部异常,请求未完成;或部分追踪器删除失败。
503 被请求的服务无效。建议直接修改该请求,不要重试该请求。
错误码
请参见错误码。