查询事件示例列表
功能介绍
查询事件示例列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/samples
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户资源空间ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,偏移量不能小于0 |
limit |
否 |
Integer |
每页显示的条目数量,不能小于1或大于1000 |
sort |
否 |
String |
指定查询排序 |
name |
否 |
String |
指定查询的事件示例名称,模糊匹配 |
event_type_name |
否 |
String |
指定查询事件示例的事件类型名称 |
event_source_id |
否 |
String |
指定查询事件示例的事件源 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
总数 |
size |
Integer |
本页数量 |
items |
Array of EventSampleItemInfo objects |
对象列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
事件示例ID |
name |
String |
事件示例名称 |
content |
String |
事件示例内容 |
event_type_id |
String |
事件示例对应的事件类型ID |
event_type_name |
String |
事件示例对应的事件类型名称 |
event_source_id |
String |
事件示例对应的事件源ID |
event_source_name |
String |
事件示例对应的事件源名称 |
created_time |
String |
创建时间 |
updated_time |
String |
更新时间 |
deleted_time |
String |
删除时间 |
请求示例
查询事件示例列表
GET https://{eg_endpoint}/v1/{project_id}/samples
响应示例
状态码:200
详情
{ "total" : 1, "size" : 1, "items" : [ { } ] }
状态码
状态码 |
描述 |
---|---|
200 |
详情 |
错误码
请参见错误码。