Creating an Event

Function

Creates an event that can be configured on one or more secret objects. When an event is enabled and the basic event type contained in the event is triggered on the secret object, the cloud service sends the corresponding event notification to the notification topic specified by the event.

Constraints

The created event notification cannot be used independently and needs to be configured on a specific secret object. The service does not check the validity of the notification object in the event notification. If the notification object does not exist under the user account, the event notification fails when the event is triggered.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/csms/events

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the created event notification. Constraint: The value can contain 1 to 64 characters and must match the regular expression ^[a-zA-Z0-9._-]{1,64}$.
event_types	Yes	Array of strings	Basic event list of the notification. The event types are as follows: 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. The basic event types in the list must be unique.
state	Yes	String	Indicates whether an event takes effect. Basic event types can be triggered only when the event is enabled. Enabled Disabled
notification	Yes	Notification object	Notification topic object.

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

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
event	Event object	Event notification object

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

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

Create an event.

{
  "name" : "demo-event",
  "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED" ],
  "state" : "ENABLED",
  "notification" : {
    "target_type" : "SMN",
    "target_id" : "urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:test-poc",
    "target_name" : "demo-smn-name"
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "event" : {
    "name" : "event-test",
    "event_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "state" : "ENABLED",
    "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED" ],
    "create_time" : 1581507580000,
    "update_time" : 1581507580000,
    "notification" : {
      "target_type" : "SMN",
      "target_id" : "urn:smn:cn-north-4:SecertExpirationTest",
      "target_name" : "SecertExpirationNotificationTest"
    }
  }
}

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.