# 查询事件列表 - ListSecretEvents #### 功能介绍 查询当前用户在本项目下创建的所有事件 #### 接口约束 此接口返回的信息为事件通知的元数据信息，不包含凭据值 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | csms::listEvents | List | - | - | csms:event:list | - | #### URI GET /v1/{project_id}/csms/events 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | String | **参数解释：** 查询返回凭据事件列表当前页面的数量 **约束限制：** 每页默认返回50，最多返回1000条凭据 **取值范围：** 不涉及 **默认取值：** 不涉及 | | marker | 否 | String | **参数解释：** 以单页最后一条凭据事件名称作为分页标记。为空时为查询第一页 **约束限制：** marker需要和limit配合使用，不能独立使用。当最后一页返回数量小于limit时，表示查询结束 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | events | Array of [Event] objects | **参数解释：** 事件详情列表 **取值范围：** 不涉及 | | page_info | [PageInfo] object | **参数解释：** 分页信息 **取值范围：** 不涉及 | 表5Event | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 消息通知 **取值范围：** 不涉及 | 表6Notification | 参数 | 参数类型 | 描述 | |:---|:---|:---| | target_type | String | **参数解释：** 事件通知的对象类型 **取值范围：** 不涉及 | | target_id | String | **参数解释：** 事件通知的对象ID **取值范围：** 不涉及 | | target_name | String | **参数解释：** 事件通知的对象名称 **取值范围：** 不涉及 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释：** 下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称） **取值范围：** 不涉及 | | previous_marker | String | **参数解释：** 本页的起始凭据名称，上一页末尾凭据名称 **取值范围：** 不涉及 | | current_count | Integer | **参数解释：** 本页返回条目数量 **取值范围：** 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求已成功 ``` { "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 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。