6.1 关键操作通知管理
6.1.4 查询关键操作通知
功能介绍
查询创建的关键操作通知规则。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/notifications/{notification_type}
表6-20 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，参见《云审计服务API 参考》“获取账号ID和项目ID”
章节。
notification_ty
pe 是 String 通知类型。
枚举值：
● smn
● fun
表6-21 Query 参数
参数 是否必选 参数类型 描述
notification_n
ame 否 String 标识关键操作通知名称。 在不
传入该字段的情况下，将查询当 前租户所有的关键操作通知。
请求参数
无
响应参数
状态码： 200
表6-22 响应 Body 参数
参数 参数类型 描述
notifications Array of
Notifications ResponseBod y objects
关键操作通知列表。
表6-23 NotificationsResponseBody
参数 参数类型 描述
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-24 Operations
参数 参数类型 描述
service_type String 标识云服务类型。必须为已对接CTS的云服务的 英文缩写，且服务类型一般为大写字母。 已对接 的云服务列表参见《云审计服务用户指南》“支 持的服务”章节。
resource_type String 标识资源类型。
trace_names Array of
strings 标识事件名称。
表6-25 NotificationUsers
参数 参数类型 描述
user_group String IAM用户组。
user_list Array of
strings IAM用户。
状态码： 400
表6-26 响应 Body 参数
参数 参数类型 描述
error_code String 错误码标识，CTS.XXX。
error_msg String 错误描述。
请求示例
"create_time" : 1633933167385, "notify_user_list" : [ {
"notification_id" : "0b98e1c2-2fd6-4e33-a355-f9e12eaab88a", "notification_name" : "test2",
"notification_type" : "smn", "operation_type" : "customized", "operations" : [ {
"resource_type" : "tracker", "service_type" : "CTS",
"trace_names" : [ "createTracker" ] }, {
"resource_type" : "notification", "service_type" : "CTS",
"trace_names" : [ "deleteNotification", "updateNotification" ] }, {
"resource_type" : "pe", "service_type" : "AOM",
"trace_names" : [ "createPolicyGroup", "updatePolicyGroup", "deletePolicyGroup" ] } ],
"project_id" : "24edf66e79d04187acb99a463e610764", "status" : "enabled",
"topic_id" : "urn:smn:cn-north-7:24edf66e79d04187acb99a463e610764:test"
}, {
"create_time" : 1633924057706, "notify_user_list" : [ {
"notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8", "notification_name" : "test1",
"notification_type" : "smn", "operation_type" : "complete", "operations" : [ ],
"project_id" : "24edf66e79d04187acb99a463e610764", "status" : "disabled"
} ] }
状态码
状态码 描述
200 查询成功。
状态码 描述
400 服务器未能处理请求。
401 请求鉴权校验失败，访问被拒绝。
403 请求权限校验失败，访问被禁止。
404 服务器无法找到被请求的资源或部分关键操作通知删除失败。
500 服务内部异常，请求未完成；或部分追踪器删除失败。
503 被请求的服务无效。建议直接修改该请求，不要重试该请求。
错误码
请参见错误码。