查询事件列表
功能介绍
查询当前用户在本项目下创建的所有事件。
接口约束
此接口返回的信息为事件通知的元数据信息，不包含凭据值。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/csms/events
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
String |
每页返回的个数。 默认值：50。 |
|
marker |
否 |
String |
分页查询起始的事件名称，为空时为查询第一页 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
通知主题对象。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
target_type |
String |
事件通知的对象类型。 |
|
target_id |
String |
事件通知的对象ID。 |
|
target_name |
String |
事件通知的对象名称。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
next_marker |
String |
下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称）。 |
|
previous_marker |
String |
本页的起始凭据名称，上一页末尾凭据名称。 |
|
current_count |
Integer |
本页返回条目数量。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：502
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：504
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
请求示例
无
响应示例
状态码：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 |
请求已成功 |
|
400 |
请求参数有误 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
认证失败 |
|
404 |
资源不存在，资源未找到 |
|
500 |
服务内部错误 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
504 |
网关超时 |
错误码
请参见错误码。
