Help Center/Data Encryption Workshop/API Reference/APIs/Secret Management APIs/Event Management/Querying Events
Updated on 2025-08-28 GMT+08:00
View PDF

Querying Events

Function

This API is used to query information about a specified event.

Constraints

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

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/csms/events/{event_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

event_name

Yes

String

Name of an event notification.

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

event

Event object

Event notification object

Table 4 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 5 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 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.

{
  "event" : {
    "name" : "event-test",
    "event_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "state" : "ENABLED",
    "event_types" : [ "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.

Error Codes

See Error Codes.

Parent Topic: Event Management