查询已触发的事件通知记录 - ListNotificationRecords

功能介绍

查询三个月内所有已触发的事件通知记录。

接口约束

仅保存三个月以内的事件通知记录。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
csms::listNotificationRecords
List
-
-
csms:event:listNotificationRecords
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
csms::listNotificationRecords	List	-	-	csms:event:listNotificationRecords	-

URI

GET /v1/{project_id}/csms/notification-records

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
records	Array of Record objects	Record对象。
page_info	PageInfo object	分页信息。

表4 Record
参数	参数类型	描述
event_name	String	凭据名称。
trigger_event_type	String	事件类型。 SECRET_VERSION_CREATED:版本创建 SECRET_VERSION_EXPIRED:版本过期 SECRET_ROTATED:凭据轮转成功 SECRET_DELETED:凭据删除 SECRET_ROTATED_FAILED:凭据轮转失败
create_time	Long	事件通知记录的创建时间，时间戳，即从1970年1月1日至该时间的总秒数。
secret_name	String	凭据名称。
secret_type	String	凭据类型 COMMON：通用凭据(默认)。用于应用系统中的各种敏感信息储存。 RDS：RDS凭据。专门针对RDS的凭据，用于存储RDS的账号信息。（已不支持，使用RDS-FG替代） RDS-FG：RDS凭据。专门针对RDS的凭据，用于存储RDS的账号信息。 GaussDB-FG：TaurusDB凭据。专门针对TaurusDB的凭据，用于存储TaurusDB的账号信息。
notification_target_name	String	事件通知的对象名称。
notification_target_id	String	事件通知的对象ID。
notification_content	String	事件通知的内容。
notification_status	String	事件通知状态。 SUCCESS：事件通知成功。 FAIL：事件通知失败。 INVALID：事件通知配置主题信息无效或不正确，无法触发通知。

表5 PageInfo
参数	参数类型	描述
next_marker	String	下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称）。
previous_marker	String	本页的起始凭据名称，上一页末尾凭据名称。
current_count	Integer	本页返回条目数量。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

表7 ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：401

表8 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

表9 ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表11** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：404

**表12** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表13** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：500

**表14** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表15** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：502

**表16** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表17** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：504

**表18** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表19** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

请求示例

无

响应示例

状态码：200

请求已成功

{
  "records" : [ {
    "event_name" : "demo-event",
    "trigger_event_type" : "SECRET_VERSION_EXPIRED",
    "create_time" : 1581507580000,
    "secret_name" : "demo-secret",
    "secret_type" : "COMMON",
    "notification_target_name" : "SecertExpirationNotificationTest",
    "notification_target_id" : "urn:smn:cn-north-4:SecertExpirationTest",
    "notification_content" : "{\"eventName\":\"TestEvent20221112\",\"eventType\":\"SECRET_VERSION_EXPIRED\",\"eventTime\":\"2023-04-14T20:25:10.126Z\",\"data\":{\"secretId\":\"fde3d6ba-cb31-40b0-b6c4-78757050f8c8\",\"secretName\":\"Secret20230325\",\"createTime\":\"2023-03-22T20:43:04.000Z\",\"updateTime\":\"2023-04-14T20:18:29.000Z\",\"versionId\":\"v18\",\"versionExpireTime\":\"2023-03-29T17:07:23.000Z\"}}",
    "notification_status" : "SUCCESS"
  } ]
}

状态码

状态码	描述
200	请求已成功
400	请求参数有误
401	被请求的页面需要用户名和密码
403	认证失败
404	资源不存在，资源未找到
500	服务内部错误
502	请求未完成。服务器从上游服务器收到一个无效的响应
504	网关超时