文档首页> 云审计服务 CTS> API参考> API V3（推荐使用）> 关键操作通知管理> 修改关键操作通知

更新时间：2024-05-21 GMT+08:00

在线调试

CLI示例

查看PDF

修改关键操作通知

功能介绍

云审计服务支持修改已创建关键操作通知配置项，通过notification_id的字段匹配修改对象，notification_id必须已经存在。

调用方法

请参见如何调用API。

URI

PUT /v3/{project_id}/notifications

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，参见获取账号ID和项目ID章节。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
notification_name	是	String	标识关键操作名称。
operation_type	是	String	标识操作类型。目前支持的操作类型有完整类型(complete)和自定义类型(customized)。完整类型下，CTS发送通知的对象为已对接服务的所有事件。自定义类型下，CTS发送通知的对象是在operations列表中指定的事件。枚举值： customized complete
operations	否	Array of Operations objects	操作事件列表。
notify_user_list	否	Array of NotificationUsers objects	通知用户列表，目前最多支持对10个用户组和50个用户发起的操作进行配置。
status	是	String	标识关键操作通知状态，包括正常(enabled)，停止(disabled)两种状态。枚举值： enabled disabled
topic_id	否	String	消息通知服务的topic_urn或者函数工作流的func_urn，当“status”字段为enabled时，该字段必填。- 消息通知服务的topic_urn可以通过消息通知服务的查询主题列表API获取，示例：urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2。- 函数工作流的func_urn可以通过函数工作流的获取函数列表API获取，示例：urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test。
notification_id	是	String	关键操作通知id。
filter	否	Filter object	关键操作通知高级筛选条件。
agency_name	否	String	云服务委托名称。参数值为"cts_admin_trust"时，创建关键操作通知时会自动创建云服务委托：cts_admin_trust。枚举值： cts_admin_trust

表3 Operations
参数	是否必选	参数类型	描述
service_type	是	String	标识云服务类型。必须为已对接CTS的云服务的英文缩写，且服务类型一般为大写字母。已对接的云服务列表参见《云审计服务用户指南》“支持审计的服务及详细操作列表”章节，单击对应云服务的文档链接，可以查看到该云服务的英文缩写。
resource_type	是	String	标识资源类型。
trace_names	是	Array of strings	标识事件名称。

表4 NotificationUsers
参数	是否必选	参数类型	描述
user_group	是	String	IAM用户组。
user_list	是	Array of strings	IAM用户。

表5 Filter
参数	是否必选	参数类型	描述
condition	是	String	多条件关系。 AND(默认值) 表示所有过滤条件满足后生效。 OR 表示有任意一个条件满足时生效。枚举值： AND(默认值) OR
is_support_filter	是	Boolean	是否打开高级筛选开关。
rule	是	Array of strings	高级过滤条件规则，示例如下："key != value"，格式为：字段规则值。-字段取值范围：api_version,code,trace_rating,trace_type,resource_id,resource_name。-规则：!= 或 =。- 值：api_version正则约束：^(a-zA-Z0-9_-.){1,64}$；code：最小长度1，最大长度256；trace_rating枚举值："normal", "warning", "incident"；trace_type枚举值："ConsoleAction", "ApiCall", "SystemAction"；resource_id：最小长度1，最大长度350；resource_name：最小长度1，最大长度256

响应参数

状态码： 200

表6 响应Body参数
参数	参数类型	描述
notification_name	String	标识关键操作名称。
operation_type	String	标识操作类型。目前支持的操作类型有完整类型(complete)和自定义类型(customized)。完整类型下，CTS发送通知的对象为已对接服务的所有事件。自定义类型下，CTS发送通知的对象是在operations列表中指定的事件。枚举值： customized complete
operations	Array of Operations objects	操作事件列表。
notify_user_list	Array of NotificationUsers objects	通知用户列表，目前最多支持对10个用户组和50个用户发起的操作进行配置。
status	String	标识关键操作通知状态，包括正常(enabled)，停止(disabled)两种状态。枚举值： enabled disabled
topic_id	String	消息通知服务的topic_urn或者函数工作流的func_urn。- 消息通知服务的topic_urn可以通过消息通知服务的查询主题列表API获取，示例：urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2。- 函数工作流的func_urn可以通过函数工作流的获取函数列表API获取，示例：urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test。
notification_id	String	关键操作通知的唯一标识。
notification_type	String	关键操作通知类型，根据topic_id区分为消息通知服务(smn)和函数工作流(fun)。枚举值： smn fun
project_id	String	项目ID。
create_time	Long	关键操作通知创建时间戳。
filter	Filter object	关键操作通知高级筛选条件。
agency_name	String	云服务委托名称。参数值为"cts_admin_trust"时，修改关键操作通知时会自动创建云服务委托：cts_admin_trust。枚举值： cts_admin_trust

表7 Operations
参数	参数类型	描述
service_type	String	标识云服务类型。必须为已对接CTS的云服务的英文缩写，且服务类型一般为大写字母。已对接的云服务列表参见《云审计服务用户指南》“支持审计的服务及详细操作列表”章节，单击对应云服务的文档链接，可以查看到该云服务的英文缩写。
resource_type	String	标识资源类型。
trace_names	Array of strings	标识事件名称。

表8 NotificationUsers
参数	参数类型	描述
user_group	String	IAM用户组。
user_list	Array of strings	IAM用户。

表9 Filter
参数	参数类型	描述
condition	String	多条件关系。 AND(默认值) 表示所有过滤条件满足后生效。 OR 表示有任意一个条件满足时生效。枚举值： AND(默认值) OR
is_support_filter	Boolean	是否打开高级筛选开关。
rule	Array of strings	高级过滤条件规则，示例如下："key != value"，格式为：字段规则值。-字段取值范围：api_version,code,trace_rating,trace_type,resource_id,resource_name。-规则：!= 或 =。- 值：api_version正则约束：^(a-zA-Z0-9_-.){1,64}$；code：最小长度1，最大长度256；trace_rating枚举值："normal", "warning", "incident"；trace_type枚举值："ConsoleAction", "ApiCall", "SystemAction"；resource_id：最小长度1，最大长度350；resource_name：最小长度1，最大长度256

状态码： 400

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码标识，CTS.XXX。
error_msg	String	错误描述。

状态码： 401

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码标识，CTS.XXX。
error_msg	String	错误描述。

状态码： 403

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码标识，CTS.XXX。
error_msg	String	错误描述。

状态码： 404

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码标识，CTS.XXX。
error_msg	String	错误描述。

状态码： 500

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码标识，CTS.XXX。
error_msg	String	错误描述。

状态码： 503

**表15** 响应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" : "test",
  "agency_name" : "cts_admin_trust",
  "operation_type" : "customized",
  "operations" : [ {
    "service_type" : "CTS",
    "resource_type" : "tracker",
    "trace_names" : [ "createTracker", "deleteTracker" ]
  }, {
    "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:{regionid}:24edf66e79d04187acb99a463e610764:foo"
}

响应示例

状态码： 200

修改关键操作通知成功。

{
  "notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
  "notification_name" : "test",
  "agency_name" : "cts_admin_trust",
  "operation_type" : "customized",
  "operations" : [ {
    "service_type" : "CTS",
    "resource_type" : "tracker",
    "trace_names" : [ "createTracker", "deleteTracker" ]
  }, {
    "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:{regionid}:24edf66e79d04187acb99a463e610764:foo"
}

状态码

状态码	描述
200	修改关键操作通知成功。
400	服务器未能处理请求。
401	请求鉴权校验失败，访问被拒绝。
403	请求权限校验失败，访问被禁止。
404	服务器无法找到被请求的资源或部分关键操作通知删除失败。
500	服务内部异常，请求未完成；或部分追踪器删除失败。
503	被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题：关键操作通知管理

上一篇：创建关键操作通知

下一篇：删除关键操作通知

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

修改关键操作通知

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线