本介面一般用於資料審計警示日誌列表查詢,便於警示搜尋和警示處理。
介面說明
使用該介面需滿足以下前提條件:
使用阿里雲或 DAS 的 SDK 時,建議使用最新版本。
在使用 SDK 調用 DAS 服務時,需要將地區指定為 cn-shanghai。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Lang |
string |
否 |
請求和接收訊息的語言類型,預設為 zh_cn。取值:
|
zh-CN |
| UserName |
string |
否 |
使用者名稱 |
admin |
| ClientIp |
string |
否 |
請求用戶端 IP。 |
11.26.118.7 |
| ClientUa |
string |
否 |
用戶端類型。 |
mysql |
| InstanceName |
string |
否 |
資產執行個體名稱 |
rm-t4ni1cezz5y3xxxx |
| DatabaseName |
string |
否 |
資料庫的名稱。 |
TestDB |
| StartTime |
integer |
否 |
警示日誌起始時間,單位為毫秒。 |
1608888296000 |
| EndTime |
integer |
否 |
警示日誌結束時間,以毫秒為單位的 unix 時間戳記。 |
15682887991222 |
| ProductCode |
string |
否 |
資料資產所屬的產品名稱。取值:RDS、PolarDB、PolarDB-X 2.0等。 |
RDS |
| ProductId |
integer |
否 |
資料對象所屬的產品名稱對應的 ID。取值:
|
5 |
| SqlText |
string |
否 |
SQL 陳述式內容。 |
SELECT * FROM test where name = 'das' |
| ExecuteTimeRange |
string |
否 |
執行時間的範圍。 |
in[1000 2000] |
| EffectRowRange |
string |
否 |
影響行數範圍。 |
in[1 33] |
| RuleID |
string |
否 |
審計規則 id。 |
9953411 |
| RuleName |
string |
否 |
審計規則名稱。 |
test_rule |
| OperateType |
string |
否 |
操作類型。 |
Insert |
| OssObjectKey |
string |
否 |
OSS 儲存物件的 key 值。 |
N.A |
| AsyncRequestId |
string |
否 |
請求 id。 |
2c548e83-1473-4fda-b3dc-5a189074ead5 |
| PageSize |
integer |
否 |
每頁最大記錄數,預設值為 10。 |
30 |
| CurrentPage |
integer |
否 |
當前頁數。 |
3 |
| RuleCategory |
string |
否 |
規則類型。 |
10 |
| LoadWhiteList |
boolean |
否 |
是否載入白名單狀態。 |
false |
| IpType |
string |
否 |
網路類型。枚舉類型,取值:
|
aliyun |
| LogSource |
string |
否 |
資料來源 |
SLOW_SQL |
| RuleAggQuery |
boolean |
否 |
是否彙總查詢 |
true |
| RuleId |
string |
否 |
規則 ID |
867028 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| AsyncRequestId |
string |
請求 id。 |
3926fba5-1774-44f4-af2d-ac7b33e86c3b |
| CurrentPage |
integer |
當前頁數。 |
1 |
| PageSize |
integer |
分頁查詢,每頁大小。 |
10 |
| RequestId |
string |
請求 ID。 |
A7021857-AFD9-5AD6-979D-AA7DFC5AFADF |
| TotalCount |
integer |
總的記錄數(僅 Redis 引擎有效) |
12 |
| Items |
array<object> |
SQL 日誌記錄中的用戶端 IP SQL 日誌記錄中用戶端的 IP 位址 |
|
|
object |
物理非同步讀。 |
||
| CreationTime |
integer |
警示時間,單位為毫秒。 |
1536751124000 |
| WarnLevel |
string |
危險等級。
|
1 |
| ClientPort |
string |
查詢中用戶端連接埠號碼 |
53815 |
| TableName |
string |
查詢中使用的表名 |
it_table |
| EffectRow |
integer |
影響行數。 |
10 |
| PackageName |
string |
MaxCompute 包名稱。 |
test01 |
| UserId |
string |
使用者 UID。 |
19********94 |
| Message |
string |
原始日誌內容。 |
success |
| RuleId |
string |
審計規則 id。 |
9953411 |
| OperateType |
string |
操作類型。 |
Drop |
| LogTime |
integer |
日誌執行時間。 |
1751870592000 |
| WarnLevelName |
string |
危險等級名稱。
|
1 |
| InstanceName |
string |
執行個體別名。 |
test-instance-003 |
| DatabaseName |
string |
資料庫名稱。 |
chngc_b2b_migration_sh |
| OssObjectKey |
string |
OSS 儲存物件的 key 值。 |
N.A |
| ExecuteStatus |
integer |
執行狀態:0:未成功 1:執行成功 |
1 |
| ProductId |
integer |
資料對象所屬的產品名稱對應的 ID。取值:
|
5 |
| ExecuteTime |
integer |
執行時間長度,單位為毫秒。 |
1751870592000 |
| UserName |
string |
使用者名稱 |
admin |
| InstanceDescription |
string |
資料資產執行個體的描述資訊。 |
instance dscription |
| RuleName |
string |
審計規則名稱。 |
name |
| ColumnName |
string |
列名。 |
ds |
| ClientIp |
string |
查詢中的用戶端 IP 位址 |
100.104.16.251 |
| ClientUa |
string |
用戶端類型。 |
mysql |
| Id |
integer |
主鍵 ID。 |
1 |
| ProductCode |
string |
資料資產所屬的產品名稱。取值:RDS、PolarDB、PolarDB-X 2.0 等。 |
RDS |
| SqlText |
string |
SQL 陳述式。 |
select * from test03 |
| InWhiteList |
boolean |
警示是否在加白列表。 |
True |
| IpType |
string |
網路類型。枚舉類型,取值: default(預設值):非阿里雲服務 aliyun: 阿里雲服務 |
aliyun |
| RuleCategory |
string |
規則類型。 |
10 |
| LogSource |
string |
資料來源 |
SLOW_SQL |
| InstanceAuditStatus |
string |
執行個體審計狀態 |
2 |
樣本
正常返回樣本
JSON格式
{
"AsyncRequestId": "3926fba5-1774-44f4-af2d-ac7b33e86c3b",
"CurrentPage": 1,
"PageSize": 10,
"RequestId": "A7021857-AFD9-5AD6-979D-AA7DFC5AFADF",
"TotalCount": 12,
"Items": [
{
"CreationTime": 1536751124000,
"WarnLevel": "1",
"ClientPort": "53815",
"TableName": "it_table",
"EffectRow": 10,
"PackageName": "test01",
"UserId": "19********94",
"Message": "success",
"RuleId": "9953411",
"OperateType": "Drop",
"LogTime": 1751870592000,
"WarnLevelName": "1",
"InstanceName": "test-instance-003",
"DatabaseName": "chngc_b2b_migration_sh",
"OssObjectKey": "N.A",
"ExecuteStatus": 1,
"ProductId": 5,
"ExecuteTime": 1751870592000,
"UserName": "admin",
"InstanceDescription": "instance dscription",
"RuleName": "name",
"ColumnName": "ds",
"ClientIp": "100.104.16.251",
"ClientUa": "mysql",
"Id": 1,
"ProductCode": "RDS",
"SqlText": "select * from test03",
"InWhiteList": true,
"IpType": "aliyun",
"RuleCategory": "10",
"LogSource": "SLOW_SQL",
"InstanceAuditStatus": "2"
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
| 403 | NoPermission | You are not authorized to do this action. | 沒有許可權執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。