刪除資料表數據
刪除資料表數據
此 API 允許您批次刪除 Agent 資料庫資料表中的指定資料記錄,每次請求最多可刪除 1000 筆記錄。
請求方法
POST
請求 URL
https://api-${endpoint}/v2/database/delete/record
認證
關於認證的詳細資訊,請參閱 API 概述 的認證部分。
請求
請求範例
curl -X POST 'https://api-${endpoint}/v2/database/delete/record' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"table_id": "673af861ed69656ac0895b07",
"delete_data":[
{
"record_id":"123456"
},
{
"filter": {
"id": "789"
}
}
]
}'
curl -X POST 'https://api-${endpoint}/v2/database/delete/record' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"table_id": "673af861ed69656ac0895b07",
"delete_data":[
{
"record_id":"123456"
},
{
"filter": {
"id": "789"
}
}
]
}'
此代碼塊在浮窗中顯示
請求標頭
| 欄位 | 類型 | 描述 |
|---|---|---|
| Authorization | Bearer ${API Key} | 使用 Authorization: Bearer ${API Key} 進行認證。API 密鑰可於 API 密鑰頁面取得。 |
| Content-Type | application/json | 資料類型,必須為 application/json。 |
請求主體
| 欄位 | 類型 | 必填 | 描述 |
|---|---|---|---|
| table_id | string | 是 | 資料表的 ID。 |
| delete_data | array | 是 | 要刪除的記錄陣列。 |
| record_id | string | 否 | 可選擇 record_id 或篩選條件,建議優先採用 record_id。 |
| filter | map | 否 | 自訂篩選條件(必須使用自訂唯一主鍵欄位)。 |
注意:您必須指定 record_id 或篩選條件其中之一,建議優先採用 record_id。如果同時提供,record_id 將優先處理。
回應
回應範例
{
"code": 0,
"message": "OK"
}
{
"code": 0,
"message": "OK"
}
此代碼塊在浮窗中顯示
成功回應
| 欄位 | 類型 | 描述 |
|---|---|---|
| code | int | 表示訊息類型的回應代碼。 |
| message | string | 回應訊息描述。 |
錯誤回應
| 欄位 | 類型 | 描述 |
|---|---|---|
| code | int | 錯誤代碼。 |
| message | string | 詳細錯誤訊息。 |
錯誤代碼
| 代碼 | 訊息 |
|---|---|
| 40000 | 參數無效 |
| 50000 | 系統內部發生錯誤 |
| 403106 | 找不到資料表 |
| 403131 | 無權存取該資料表 |
