狀態代碼參考
AI搜尋開放平台服務的API/SDK調用將返回狀態代碼以標識調用結果。請通過返回結果中的code和status欄位定位調用成功或失敗的詳細資料。
下表列出AI搜尋開放平台通用狀態代碼資訊。
類別 | httpStatusCode | code | message | 錯誤說明 |
請求錯誤 | 400 | InvalidParameter | Required parameter(s) missing or invalid, please check the request parameters. | 介面調用參數不合法。 |
400 | ServiceIdNotExist | service_id is not exist. | 服務ID不存在。 | |
429 | Throttling | Requests throttling triggered. | 介面調用觸發限流。 | |
429 | Throttling.RateQuota | Requests rate limit exceeded, please try again later. | 調用頻次觸發限流，比如每秒鐘請求數。 | |
429 | Throttling.AllocationQuota | Allocated quota exceeded, please increase your quota limit. | 一段時間調用量觸發限流，比如每分鐘產生Token數。 | |
429 | Throttling.AllocationQuota | Free allocated quota exceeded. | 免費額度已經耗盡，並且模型未開通計費訪問。 | |
服務端錯誤 | 500 | InternalServerError | An internal error has occured, please try again later or contact service support. | 系統內部錯誤。 |
返回欄位參考
AI搜尋開放平台服務在訪問失敗的情況下，除HTTP狀態代碼外還會返回錯誤的細節資訊，一個訪問失敗樣本的調用可能有如下所示返回：
{
"request_id": "817964CD-1B84-4AE1-9B63-4FB99734DD41",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Invalid UTF-8 start byte 0xbc; nested exception is com.fasterxml.jackson.core.JsonParseException: Invalid UTF-8 start byte 0xbc\n at line: 2, column: 19]"
}返回參數說明
返回參數 | 類型 | 說明 |
HTTP請求返回碼 | integer | 200（HTTPStatus.OK）表示請求成功，否則表示請求失敗，可以通過code擷取錯誤碼，通過message欄位擷取錯誤詳細資料。 |
request_id | string | 系統對一次API調用賦予的唯一標識。當排查問題的時候，開發人員可以將 request_id 進行反饋以定位某次調用。 |
code | string | 如果失敗表示錯誤碼，參考狀態代碼表“錯誤碼”部分。 |
message | string | 如果失敗，內容為失敗詳細資料，參考狀態代碼表“錯誤資訊”部分，需要注意的是這部分內容可能會隨著具體的情況有所不同，可能會輸出更加有針對性的內容，不一定和上述碼錶中的資訊完全一致。 |