事件查询接口
更新时间:2024-01-08
查询
接口描述
用于查询用户审计事件。
权限说明
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成,均为字符串。 对于每个HTTP请求,使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}
。
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号(;)分隔,如host;x-bce-date。列表按照字典序排列。(本API签名仅使用host和x-bce-date两个header)
- signature是256位签名的十六进制表示,由64个小写字母组成。
当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;如果认证字符串不同,系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见鉴权认证。
注意事项
主账号、管理员子用户、授予BCTReadPolicy或者BCTFullControlPolicy权限的子用户可通过AK/SK访问该接口
请求结构
POST /v1/events/query HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string
{
"filters": [
{
"field": "field1",
"value": "value1"
},
{
"field": "field2",
"value": "value2"
}
],
"startTime": "startTime",
"endTime": "endTime",
"pageNo": startNo,
"pageSize": size
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
pageNo | int | 是 | RequestBody参数 | 页数,最小为1 |
pageSize | int | 是 | RequestBody参数 | 每页项目数量,最小为1,最大100 |
startTime | string | 是 | RequestBody参数 | 查询起始时间,使用UTC时间 |
endTime | string | 是 | RequestBody参数 | 查询截止时间,使用UTC时间 |
domainId | string | 是 | RequestBody参数 | 账户ID, 必须与请求头的签名信息对应 |
filters | List<Filter> | 是 | RequestBody参数 | 查询过滤条件,数组形式 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
page | int | 分页页数 |
pageSize | int | 每页项目数量,最小为1 |
total | int | 查询总数 |
data | List<Event> | 事件详情数组 |
请求示例
POST http://iam.bj.baidubce.com/v1/events/query
Host: iam.bj.baidubce.com
Authorization: bce-auth-v1/e5760f03b10841cbbb73888755367f4e/2020-08-13T07:14:30Z/1800/host/4926f1123e6ea395e6e98ff0c5f2e21b37b8f76531a7e18da7dbdeec9ac0bce8
{
"domainId": "d22e12e9d0af4b53b700787b338b8",
"startTime": "2023-05-09T16:00:00Z",
"endTime": "2023-12-26T15:59:59Z",
"filters": [
{
"field": "eventName",
"value": "ConsoleLogin"
},
{
"field": "currentUser",
"value": "d22e12e9d0af4b53b700787b338b8"
}
],
"pageNo": 1,
"pageSize": 30
}
响应示例
HTTP/1.1 200 OK
X-Bce-Request-Id: ef4d2887-0e3c-4dce-ad67-06e4afa7f342
Date: Thu, 13 Aug 2020 07:15:25 GMT
Content-Type: application/json; charset=utf-8
{
"total":1,
"page":1,
"pageSize":30,
"data":[
{
"eventType":"普通事件",
"eventSource":"login",
"eventName":"ConsoleLogin",
"eventTimeInMilliseconds":1597040510728,
"eventTime":"2020-08-10T06:21:50Z",
"userIpAddress":"211.95.58.7",
"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.",
"regionId":"",
"requestId":"e63acc154ad84b3db140f58f07ae78ce",
"orderId":"",
"apiVersion":"1.0.0",
"description":"",
"errorCode":"302",
"errorMessage":"",
"success":true,
"userIdentity":{
"iamDomainId":"d22e12e9d0af4b53b700787b338b8",
"iamUserId":"d22e12e9d0af4b53b700787b338",
"loginUserId":"",
"userDisplayName":"test_user"
}
]
}