1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询日志列表信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDspmLogList。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"] |
| Limit | 否 | Integer | 限制数目 示例值:10 |
| Offset | 否 | Integer | 偏移量 示例值:1 |
| Sort | 否 | String | 排序方式(desc=倒叙,asc=升序) 示例值:desc |
| Field | 否 | String | 排序字段(opTime=时间,dangerLvl=风险等级) 示例值:dangerLvl |
| DangerLevel | 否 | String | 风险等级(0-安全,1-低风险,2-中风险,3-高风险,不传全部) 示例值:1 |
| DbName | 否 | String | 数据库名称 示例值:user |
| DbPort | 否 | Integer | 数据库端口 示例值:3306 |
| DbIp | 否 | String | 数据库 IP 示例值:142.146.87.47 |
| AssetsId | 否 | Integer | 资产 ID 示例值:10010 |
| SessionId | 否 | String | 会话 ID 示例值:kssekw |
| ClientSideIp | 否 | String | 客户端 IP 示例值:56.76.244.85 |
| EndTime | 否 | Integer | 结束时间 示例值:1730444966 |
| HitRule | 否 | Integer | 命中规则 示例值:10010 |
| StartTime | 否 | Integer | 开始时间 示例值:1730344966 |
| FuzzySearch | 否 | String | 模糊查询 示例值:select |
| UserName | 否 | String | 用户名 示例值:root |
| RestoreLogId | 否 | Integer | 恢复日志id 示例值:1 |
| ClientName | 否 | String | 客户端 示例值:Proxy |
| SourceTypes.N | 否 | Array of String | 流量来源,取值 Agent/Proxy/空;传Agent会返回Agent的日志,传Proxy会返回Proxy日志,两者都传或不传则返回所有 示例值:["agent"] |
| TableName | 否 | String | 表名,长度限制64,多个表名查询的话可以用空格连接 示例值:table_1 |
| FieldName | 否 | String | 字段名,长度限制64,多个字段名查询的话可以用空格连接 示例值:field_1 |
| SqlMainTypes.N | 否 | Array of String | SQL 主要类型,DDL, DML, DCL, TCL 示例值:["DDL", "DML", "DCL", "TCL"] |
| SqlType | 否 | String | 操作类型 示例值:select/update等 |
| RowNumMin | 否 | Integer | 影响行数最小值 示例值:1 |
| RowNumMax | 否 | Integer | 影响行数最大值 示例值:10 |
| DbTypes.N | 否 | Array of String | 数据库类型 示例值:["mysql"] |
| RetNo | 否 | Integer | 返回码 示例值:0 |
| ClientDriverName | 否 | String | 客户端工具 示例值:redis-cli |
| ClientPort | 否 | Integer | 客户端端口 示例值:65535 |
| LogId | 否 | String | 审计日志 ID 示例值:xksksses |
| DangerLevels.N | 否 | Array of Integer | 风险等级数组(0-安全,1-低风险,2-中风险,3-高风险) 示例值:[1] |
| SensitiveCategoryRule | 否 | String | 字段分类 示例值:1. 为空:"empty"; 2.不为空:"non-empty";3. 模糊查询:如 "个人身份信息"、"身份证" |
| SensitiveLevelRisk | 否 | String | 字段分级 示例值:高 |
| ClientMac | 否 | String | 客户端MAC 示例值:00-11-22-33-44-55 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数目 示例值:10 |
| List | Array of AuditLogInfo | 日志信息列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据风险等级升序查询日志列表
根据风险等级升序查询日志列表
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogList
<公共请求参数>
{
"Sort": "desc",
"DbPort": 0,
"FuzzySearch": "select",
"HitRule": 0,
"DangerLevel": "high",
"RestoreLogId": 0,
"AssetsId": 0,
"UserName": "root",
"DbIp": "127.0.0.1",
"Field": "ip",
"SessionId": "1711987200000-140227893131008-2045",
"Limit": 1,
"StartTime": 0,
"Offset": 1,
"EndTime": 0,
"ClientSideIp": "127.0.0.1",
"DbName": "mysql",
"ClientName": "Proxy"
}
输出示例
{
"Response": {
"TotalCount": 1,
"List": [
{
"AiScore": 1,
"AppUser": "testuser",
"BackPacket": "",
"ClientIp": "127.0.0.1",
"ClientMac": "52:54:00:c9:38:87",
"ClientName": "root",
"ClientUser": "39510",
"ClientPort": 3306,
"DangerLevel": 1,
"DbIp": "127.0.0.1",
"DbName": "monitor",
"DbPort": 3306,
"DbUser": "root",
"EffectRow": 0,
"ExecTime": 1,
"HitRule": "10000",
"Id": 104709,
"InstanceId": 1,
"InstanceName": "审计测试资产",
"OpSql": "login",
"OpTime": 1631760308,
"RetMsg": "login failed",
"RetNo": 0,
"SessionId": "1631721600000-140388847871744-5319",
"SqlType": "LOGIN",
"TableName": "information_schema",
"AssetName": "审计测试资产",
"HitRules": [],
"SourceType": "cdb",
"ReqId": "req-testidaseeada",
"SqlMainType": "DML",
"TableNames": [
"table1,table2,table3"
],
"FieldNames": [
"field1,field2,field3"
],
"FieldName": "phonenum,username,id",
"DbType": "MYSQL",
"ClientDriverName": "mongosh"
}
],
"RequestId": "a8aa8bbc-c255-42b1-88c4-04419f435a77"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DasbAmountNotEnough | FailedOperation.DasbAmountNotEnough |
| FailedOperation.DasbErrorCode | FailedOperation.DasbErrorCode |
| FailedOperation.DasbInvalidSecretId | FailedOperation.DasbInvalidSecretId |
| FailedOperation.DasbInvalidSecretKey | FailedOperation.DasbInvalidSecretKey |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ResourceId | InvalidParameter.ResourceId |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |