Querying Triggered Event Notification Records

Function

Query all event notification records that have been triggered in the last three months.

Constraints

Only event notification records generated within three months are stored.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
records	Array of Record objects	Record object
page_info	PageInfo object	Pagination information.

**Table 4** Record
Parameter	Type	Description
event_name	String	Secret name.
trigger_event_type	String	Event type. SECRET_VERSION_CREATED: Version created. SECRET_VERSION_EXPIRED: Version expired. SECRET_ROTATED: Secret rotated. SECRET_DELETED: Secret deleted. SECRET_ROTATED_FAILED: The secret fails to be rotated.
create_time	Long	Time when an event notification record is created. The value is a timestamp, that is, the total number of seconds from January 1, 1970 to the time specified by this parameter.
secret_name	String	Secret name
secret_type	String	Secret type COMMON: shared secret (default), which is used to store sensitive information in an application system. RDS: RDS secret, which is used to store RDS account information. (no longer supported, replaced by RDS-FG) RDS-FG: RDS secret, which is used to store RDS account information. GaussDB-FG: TaurusDB secret, which is used to store TaurusDB account information.
notification_target_name	String	Name of the object to which the event notification is sent.
notification_target_id	String	ID of the object to which the event notification is sent.
notification_content	String	Event notification
notification_status	String	Event notification status. SUCCESS: Event notification succeeded. FAIL: Event notification failed. INVALID: Failed to send the event notification because the topic is invalid or incorrect.

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	Query address of the next page (name of the secret at the end of the current page, name of the secret at the start of the next page).
previous_marker	String	Name of the start secret on the current page and name of the end secret on the previous page.
current_count	Integer	Number of records returned on this page.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 7** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 9** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 11** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 404

**Table 12** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 13** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 500

**Table 14** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 15** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 502

**Table 16** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 17** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 504

**Table 18** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 19** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "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"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	A username and password are required.
403	Authentication failed.
404	The requested resource does not exist or is not found.
500	Internal service error.
502	Failed to complete the request because the server receives an invalid response from an upstream server.
504	Gateway timed out.