更新时间:2026-05-20 GMT+08:00
分享

查询事件 - ShowSecretEvent

功能介绍

查询指定事件的信息

接口约束

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

调用方法

请参见如何调用API

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    csms::getEvent

    Read

    -

    -

    csms:event:get

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32

默认取值:

不涉及

event_name

String

参数解释:

事件通知的名称

约束限制:

不涉及

取值范围:

满足正则要求:^[a-zA-Z0-9_-]{1,64}$

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选

约束限制:

不涉及

取值范围:

IAM服务查询用户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

参数解释:

事件通知的对象类型

约束限制:

站点支持SMN消息或者EG消息的,可供选择

取值范围:

不涉及

默认取值:

不涉及

target_id

String

参数解释:

事件通知的对象ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

target_name

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

请求已成功

错误码

请参见错误码

相关文档