查询 SQL 审计配置
该接口仅支持 TiDB 企业版。
接口URL
/api/v1/cluster/sqlaudit/{clusterID}/config
请求方式
GET
Content-Type
application/json
认证方式
Bearer auth
路径变量
| 参数名 | 示例值 | 参数描述 |
|---|---|---|
| clusterID | - | - |
成功响应示例
{
"Data": {
"LogRedacted": true,
"LogReservedDays": 3,
"LogReservedBackups": 10,
"LogMaxLifeTime": 86400,
"LogMaxFileSize": 100,
"LogFormat": "TEXT",
"LogPath": "tidb-audit.log"
},
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| Data | - | Object | - |
| Data.LogRedacted | true | Boolean | - |
| Data.LogReservedDays | 3 | Integer | 日志保留天数 |
| Data.LogReservedBackups | 10 | Integer | - |
| Data.LogMaxLifeTime | 86400 | Integer | - |
| Data.LogMaxFileSize | 100 | Integer | - |
| Data.LogFormat | TEXT | String | - |
| Data.LogPath | tidb-audit.log | String | - |
| Success | true | Boolean | 调用是否成功 |