查询事件 - ShowSecretEvent

功能介绍

查询指定事件的信息。

接口约束

此接口返回的信息为凭据事件通知的元数据信息值。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
csms::getEvent
Read
-
-
csms:event:get
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
csms::getEvent	Read	-	-	csms:event:get	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。
event_name	是	String	事件通知的名称。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
event	Event object	事件通知对象。

表4 Event
参数	参数类型	描述
name	String	事件通知名称。
event_id	String	事件通知的资源标识符。
event_types	Array of strings	设置事件的基础事件类型列表。约束：数组大小：最小1，最大12。
state	String	事件通知状态，取值如下。 ENABLED：表示启用状态 DISABLED：表示禁用状态
create_time	Long	事件通知创建时间，时间戳，即从1970年1月1日至该时间的总秒数。
update_time	Long	事件通知上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。
notification	Notification object	通知主题对象。

表5 Notification
参数	参数类型	描述
target_type	String	事件通知的对象类型。
target_id	String	事件通知的对象ID。
target_name	String	事件通知的对象名称。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

表7 ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：401

表8 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

表9 ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表11** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：404

**表12** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表13** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：500

**表14** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表15** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：502

**表16** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表17** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

状态码：504

**表18** 响应Body参数
参数	参数类型	描述
error	ErrorDetail object	错误信息返回体。

**表19** ErrorDetail
参数	参数类型	描述
error_code	String	错误请求返回的错误码
error_msg	String	错误请求返回的错误信息

请求示例

无

响应示例

状态码：200

请求已成功

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

状态码

状态码	描述
200	请求已成功
400	请求参数有误
401	被请求的页面需要用户名和密码
403	认证失败
404	资源不存在，资源未找到
500	服务内部错误
502	请求未完成。服务器从上游服务器收到一个无效的响应
504	网关超时