1. 接口描述
接口请求域名： cloudaudit.tencentcloudapi.com 。
查询操作审计日志
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeEvents。 |
| Version | 是 | String | 公共参数，本接口取值：2019-03-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| StartTime | 是 | Integer | 起始时间戳（单位秒，不超过当前时间 90 天） 示例值：1612171581 |
| EndTime | 是 | Integer | 结束时间戳（单位秒，查询时间跨度小于 30 天） 示例值：1612173581 |
| NextToken | 否 | Integer | 查看更多日志的凭证 示例值：123213213312313 |
| MaxResults | 否 | Integer | 返回日志的最大条数（最大 50 条） 示例值：10 |
| LookupAttributes.N | 否 | Array of LookupAttribute | 检索条件（目前支持 RequestId：请求 ID、EventName：事件名称、ActionType：操作类型（Write：写；Read：读）、PrincipalId：子账号、ResourceType：资源类型、ResourceId：资源Id、ResourceName：资源名称、AccessKeyId：密钥 ID、SensitiveAction：是否敏感操作、ApiErrorCode：API 错误码、CamErrorCode：CAM 错误码、Tags：标签（AttributeValue格式：[{"key":"*","value":"*"}]）备注:检索的各个条件间是与的关系,EventName传多个值内部是或的关系） 示例值：[{"AttributeKey:XX,"AttributeValue":xx}] |
| IsReturnLocation | 否 | Integer | 是否返回 IP 归属地（1 返回，0 不返回） 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ListOver | Boolean | 日志集合是否结束。true表示结束，无需进行翻页。 示例值：false |
| NextToken | Integer | 查看更多日志的凭证 示例值：123123213 |
| Events | Array of Event | 日志集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "CloudAuditEvent": "", "EventName": "PostTrack", "EventTime": "xxxx", "EventId": "", "SecretId": "xxxxxxA2bADrx2jeiQPQy2kIV05F4xjl9Nxxxxx", "ErrorCode": 0, "RequestID": "xxxxx-8fd8-4121-b1e8-6264292eeb4f", "SourceIPAddress": "xx.xx.96.xx", "EventSource": "xx.ap-chongqing.api.tencentyun.com/", "EventRegion": "ap-guangzhou", "Resources": { "ResourceName": "", "ResourceType": "tandon" }, "Username": "root", "AccountID": xxxx, "Location": "xxxx", "ResourceTypeCn": "腾讯云安灯", "EventNameCn": "智能客服官网浏览记录上报", "ResourceRegion": "" } ] |
| TotalCount | Integer | 此字段已经废弃。翻页请使用ListOver配合NextToken，在ListOver为false进行下一页数据读取。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询操作审计日志
查询操作审计日志
输入示例
POST / HTTP/1.1
Host: cloudaudit.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEvents
<公共请求参数>
{
"StartTime": 1610613170,
"EndTime": 1610699570,
"MaxResults": 1
}输出示例
{
"Response": {
"ListOver": true,
"Events": [
{
"CloudAuditEvent": "{\"userIdentity\":{\"principalId\":\"1000000000\",\"accountId\":\"1000000000\",\"secretId\":\"xxx\",\"sessionContext\":\"{\\\"token\\\": \\\"xxx--Jqr7dXvw3EBEXWNcJljzbZeJeoIrQx9gafWtHV1Lg9zu7hSpY91LAF414n21D41bpodncbz8u12C-xxx\\\", \\\"ua\\\": \\\"xxx\\\", \\\"userIp\\\": \\\"111.111.11.111\\\", \\\"uin\\\": 1000000000, \\\"ownerUin\\\": 1000000000, \\\"appId\\\": 1256196555, \\\"expireTime\\\": \\\"2023-04-03 19:23:29\\\", \\\"mfa\\\": 1, \\\"mfaExpireTime\\\": \\\"0000-00-00 00:00:00\\\", \\\"interfaceName\\\": \\\"\\\", \\\"hasPolicyFilter\\\": 0, \\\"policyFilter\\\": \\\"\\\", \\\"extraInfo\\\": \\\"{\\\\\\\"dictId\\\\\\\":2208,\\\\\\\"mfaExpireTime\\\\\\\":\\\\\\\"3000-12-12 00:00:00\\\\\\\",\\\\\\\"sessionUin\\\\\\\":5000}\\\"}\",\"type\":\"Root\",\"userName\":\"root\"},\"eventRegion\":\"ap-guangzhou\",\"eventVersion\":2,\"errorCode\":\"0\",\"errorMessage\":\"\",\"requestID\":\"008ef803-4549-41fe-a7e6-433122273683\",\"eventID\":\"008ef803-4549-41fe-a7e6-433122273683\",\"apiVersion\":\"3.0\",\"eventType\":\"ConsoleCall\",\"actionType\":\"Write\",\"httpMethod\":\"POST\",\"apiErrorCode\":0,\"apiErrorMessage\":\"\",\"userAgent\":\"SDK_NODEJS_0.2.1\",\"eventTime\":1680513809,\"sourceIPAddress\":\"111.111.111.111\",\"eventSource\":\"cloudaudit.ap-guangzhou.api.tencentyun.com\",\"resources\":\"[\\\"*\\\"]\",\"resourceName\":\"\",\"resourceSet\":[],\"requestParameters\":\"{\\\"ActionType\\\":\\\"Write\\\",\\\"EventNames\\\":[\\\"*\\\"],\\\"Name\\\":\\\"qweqwe\\\",\\\"ResourceType\\\":\\\"*\\\",\\\"Status\\\":1,\\\"Storage\\\":{\\\"StorageName\\\":\\\"d0f00ec9-5643-4a11-9022-187621d38714\\\",\\\"StoragePrefix\\\":\\\"cloudaudit\\\",\\\"StorageRegion\\\":\\\"ap-guangzhou\\\",\\\"StorageType\\\":\\\"cls\\\"},\\\"Version\\\":\\\"2019-03-19\\\"}\",\"responseElements\":\"{\\\"TrackId\\\":21915,\\\"RequestId\\\":\\\"008ef803-4549-41fe-a7e6-433122273683\\\"}\",\"resourceType\":\"cloudaudit\",\"eventName\":\"CreateAuditTrack\",\"sensitiveAction\":\"1\",\"tags\":[\"\"]}",
"EventName": "CreateAuditTrack",
"EventTime": "1680513809",
"SecretId": "xxxxxxx",
"ErrorCode": 0,
"RequestID": "008ef803-4549-41fe-a7e6-433122273683",
"SourceIPAddress": "111.111.111.111",
"EventSource": "cloudaudit.ap-guangzhou.api.tencentyun.com",
"EventRegion": "ap-guangzhou",
"Resources": {
"ResourceName": "",
"ResourceType": "cloudaudit"
},
"Username": "root",
"AccountID": 100004293724,
"Location": "中国 广东省 深圳市 中国电信",
"ResourceTypeCn": "操作审计",
"EventNameCn": "创建操作审计跟踪集",
"ResourceRegion": ""
}
],
"TotalCount": 1,
"NextToken": 16805138109322956,
"RequestId": "42a0e189-2869-488f-aa34-8bffd0814322"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.MemberNotAuditRole | 当前查询的用户还未开通操作审计权限，如需查询该用户审计记录，请联系其开通！ |
| FailedOperation.MemberNotInOrganization | 成员不在集团组织中。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded.OverAmount | 超过跟踪集的最大值 |
| UnauthorizedOperation | 未授权操作。 |
