Querying the Event List

Function

This API is used to query all events created by the current user in the project.

Constraints

The information returned by this API is the metadata information of the event notification, excluding the secret value.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/csms/events

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	String	Specifies the number of records on each page. Default value: 50
marker	No	String	Start event name of pagination query. If this parameter is left blank, only the first page is queried.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
events	Array of Event objects	Event details list
page_info	PageInfo object	Pagination information.

**Table 5** Event
Parameter	Type	Description
name	String	Event notification name.
event_id	String	Indicates the resource identifier of the event notification.
event_types	Array of strings	Set the basic event type list of the event. Constraint: The array can contain up to 12 elements.
state	String	Event notification status. The options are as follows: ENABLED DISABLED
create_time	Long	Time when an event notification 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.
update_time	Long	Last update time of the event notification. The value is a timestamp, that is, the total number of seconds from January 1, 1970 to the time.
notification	Notification object	Notification topic object.

**Table 6** Notification
Parameter	Type	Description
target_type	String	Type of the object to which an event notification is sent.
target_id	String	ID of the object to which the event notification is sent.
target_name	String	Name of the object to which the event notification is sent.

**Table 7** 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 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: 401

**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: 403

**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: 404

**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: 500

**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: 502

**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.

Status code: 504

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

**Table 21** 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.

{
  "events" : [ {
    "state" : "ENABLED",
    "name" : "TestEvent1",
    "event_id" : "120eeafd-eca5-4098-8733-c1b369f3a450",
    "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED", "SECRET_VERSION_NEAR_EXPIRY", "SECRET_DELETED" ],
    "create_time" : 1669042498000,
    "update_time" : 1669042498000,
    "notification" : {
      "target_type" : "SMN",
      "target_id" : "urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:smn-target-name",
      "target_name" : "smn-target-name"
    }
  }, {
    "state" : "ENABLED",
    "name" : "TestEvent2",
    "event_id" : "1d251c99-37d2-4396-86ce-f000d3aa9850",
    "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED", "SECRET_VERSION_NEAR_EXPIRY", "SECRET_DELETED" ],
    "create_time" : 1669041491000,
    "update_time" : 1669041491000,
    "notification" : {
      "target_type" : "SMN",
      "target_id" : "urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:smn-target-name",
      "target_name" : "smn-target-name"
    }
  } ],
  "page_info" : {
    "next_marker" : "TestEvent2",
    "previous_marker" : "TestEvent3",
    "current_count" : 2
  }
}

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.