查询事件列表(v2.0)
功能介绍
通过事件列表查询接口,可以查出系统记录的7天内资源操作记录。
URI
GET /v2.0/{project_id}/{tracker_name}/trace
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见获取项目ID。 |
tracker_name |
是 |
String |
当前版本单租户仅支持一个追踪器,名称默认为“system”。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
service_type |
否 |
String |
标识查询事件列表对应的云服务类型。必须为已对接CTS的云服务的英文缩写,且服务类型一般为大写字母。 已对接的云服务列表参见《云审计服务用户指南》“支持审计的服务及详细操作列表”章节,单击对应云服务的文档链接,可以查看到该云服务的英文缩写。 |
user |
否 |
String |
标识特定用户名称,用以查询该用户下的所有事件。 |
from |
否 |
Long |
标识查询事件列表的起始时间戳(timestamp,为标准UTC时间,毫秒级,13位数字,不包括传入时间)默认为上一小时的时间戳。查询条件from与to配套使用。 |
limit |
否 |
Integer |
标示查询事件列表中限定返回的事件条数。不传时默认10条,最大值200条。 |
next |
否 |
String |
取值为响应中中marker的值,用于标识查询事件的起始时间(自此条事件的记录时间起,向更早时间查询)。 可以与“from”、“to”结合使用。 最终的查询条件取两组时间条件的交集。 |
resource_id |
否 |
String |
标示查询事件列表对应的云服务资源ID。 |
resource_name |
否 |
String |
标示查询事件列表对应的的资源名称。 说明:该字段可能包含大写字母。 |
resource_type |
否 |
String |
标示查询事件列表对应的资源类型。 |
to |
否 |
Long |
标识查询事件列表的结束时间戳(timestamp,为标准UTC时间,毫秒级,13位数字,不包括传入时间)默认为当前时间戳。查询条件to与from配套使用。 |
trace_id |
否 |
String |
标示某一条事件的事件ID。当传入这个查询条件时,其他查询条件自动不生效。 |
trace_name |
否 |
String |
标示查询事件列表对应的事件名称。 说明:该字段可能包含大写字母。 |
trace_rating |
否 |
String |
标示查询事件列表对应的事件等级目前有三种:正常(normal), 警告(warning),事故(incident)。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
traces |
Array of Traces objects |
本次查询事件列表返回事件数组。 |
meta_data |
MetaData object |
本次查询事件条数和标记位。 |
参数 |
参数类型 |
描述 |
---|---|---|
resource_id |
String |
标识事件对应的云服务资源ID。 |
trace_name |
String |
标识查询事件列表对应的事件名称。由0-9,a-z,A-Z,'-','.','_',组成,长度为1~64个字符,且以首字符必须为字母。 |
trace_rating |
String |
标识事件等级,目前有三种:正常(normal),警告(warning),事故(incident)。 枚举值:
|
trace_type |
String |
标识事件发生源头类型,主要包括API调用(ApiCall),Console页面调用(ConsoleAction)和系统间调用(SystemAction)。 |
request |
String |
标识事件对应接口请求内容,即资源操作请求体。 |
response |
String |
记录用户请求的响应,标识事件对应接口响应内容,即资源操作结果返回体。 |
code |
String |
记录用户请求的响应,标识事件对应接口返回的HTTP状态码。 |
api_version |
String |
标识事件对应的云服务接口版本。 |
message |
String |
标识其他云服务为此条事件添加的备注信息。 |
record_time |
Long |
标识云审计服务记录本次事件的时间戳。 |
trace_id |
String |
标识事件的ID,由系统生成的UUID。 |
time |
Long |
标识事件产生的时间戳。 |
user |
UserInfo object |
标识触发事件的用户信息。 |
service_type |
String |
标识查询事件列表对应的云服务类型。必须为已对接CTS的云服务的英文缩写,且服务类型一般为大写字母。已对接的云服务列表参见《云审计服务用户指南》“支持审计的服务及详细操作列表”章节,单击对应云服务的文档链接,可以查看到该云服务的英文缩写。 |
resource_type |
String |
查询事件列表对应的资源类型。 |
source_ip |
String |
标识触发事件的租户IP。 |
resource_name |
String |
标识事件对应的资源名称。 |
request_id |
String |
记录本次请求的request id |
location_info |
String |
记录本次请求出错后,问题定位所需要的辅助信息。 |
endpoint |
String |
云资源的详情页面 |
resource_url |
String |
云资源的详情页面的访问链接(不含endpoint) |
请求示例
GET https://{endpoint}/v2.0/{project_id}/{tracker_name}/trace?limit=11&to=1479095278000&from=1478490478000&trace_name=createTracker&resource_type=tracker&service_type=CTS
响应示例
状态码: 200
请求正常。
{ "meta_data" : { "count" : 2, "marker" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8" }, "traces" : [ { "time" : 1472148708232, "user" : { "name" : "xxx", "domain" : { "name" : "xxx", "id" : "ded649d814464428ba89d04d7955c93e" } }, "response" : { "code" : "VPC.0514", "message" : "Update port fail." }, "code" : 200, "service_type" : "VPC", "resource_type" : "eip", "resource_name" : "192.144.163.1", "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc", "trace_name" : "deleteEip", "trace_rating" : "warning", "trace_type" : "ConsoleAction", "api_version" : "2.0", "record_time" : 1481066128032, "trace_id" : "e001ccb9-bc09-11e6-b00b-4b2a61338db6" }, { "time" : 1472148708232, "user" : { "name" : "xxx", "domain" : { "name" : "xxx", "id" : "ded649d814464428ba89d04d7955c93e" } }, "response" : { "code" : "VPC.0514", "message" : "Update port fail." }, "code" : 200, "service_type" : "VPC", "resource_type" : "eip", "resource_name" : "192.144.163.1", "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc", "trace_name" : "deleteEip", "trace_rating" : "warning", "trace_type" : "ConsoleAction", "api_version" : "2.0", "record_time" : 1481066128032, "trace_id" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
请求正常。 |
400 |
查询参数异常,请求未完成。 |
401 |
请求鉴权校验失败,访问被拒绝。 |
403 |
请求权限校验失败,访问被禁止。 |
404 |
查询事件不存在,请求未完成。 |
500 |
服务内部异常,请求未完成。 |
503 |
被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。