Querying Triggered Event Notification Records
Function
This API is used to query all event notifications 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. This parameter is optional if AK/SK authentication is used. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| records | Array of Record objects | Definition Secret event notification record Range N/A |
| page_info | PageInfo object | Definition Pagination information. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| next_marker | String | Definition Query address of the next page (secret name at the end of the current page and the start of the next page) Range N/A |
| previous_marker | String | Definition Secret name at the start of the current page and the end of the last page Range N/A |
| current_count | Integer | Definition Number of records returned on this page Range N/A |
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" : "SecretExpirationNotificationTest",
"notification_target_id" : "urn:smn:cn-north-4:SecretExpirationTest",
"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"
} ],
"page_info" : {
"next_marker" : "next_secret",
"previous_marker" : "previous_secret",
"current_count" : 10
}
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Request succeeded. |
Error Codes
See Error Codes.