根據ID取得收益匯出請求
取得現有佇列導出要求的狀態。
REST 要求
GET https://api.partner.microsoft.com/v1.0/payouts/transactionhistory/{transactionHistoryRequestId}
要求參數
名字 | 在 | 必填 | 類型 | 描述 |
---|---|---|---|---|
請求ID | 查詢 | 正確 | Guid | 匯出要求標識碼 |
請求標頭
名字 | 必填 | 類型 | 描述 |
---|---|---|---|
授權 | 是的 | 字串 | 授權持有人令牌。 |
ms-correlationid | 不 | 字串 | 內部請求追蹤器。 每個要求都會產生新的追蹤器 (GUID)。 |
ms-requestid | 不 | 字串 | 請求冪等性ID。 |
請求主體
N/A.
回應負載
API 會傳回 HTTP 狀態 200。
根據要求,API 可以傳回標準 API 回應狀態中列出的其他標準狀態:
名字 | 描述 |
---|---|
400 錯誤的請求 | 數據遺失或不正確。 |
401 未經授權 | 呼叫端未通過驗證,且必須先向合作夥伴 API 服務進行驗證,才能進行第一次呼叫。 |
403 禁止存取 | 呼叫端無權提出要求。 |
500 內部伺服器錯誤 | API 或其其中一個相依性無法滿足要求。 稍後再試一次。 |
404 找不到 | 資源無法與輸入參數一同使用。 |
429 速率限制 | 相同類型的要求太多。 請稍後再試一次。 |
API 回應承載會傳回下列屬性:
名字 | 可選的 | 描述 |
---|---|---|
價值 | 假 | 如需可能的值和動作,請參閱下表。 |
可能的值和動作
價值 | 用戶端動作 |
---|---|
請求ID(requestId) | 匯出請求的識別碼。 |
請求日期時間 | 匯出要求的起始日期時間。 |
請求路徑 | 匯出要求的查詢路徑。 |
requestQueryString | 做為匯出要求的一部分使用的篩選。 |
blobLocation | 導出檔案準備就緒時,帶有令牌的 Blob 資源。 |
地位 | 匯出作業狀態。 狀態的可能值請參閱下列表格。 |
狀態 的可能值
- 佇列:導出作業尚未啟動
- 處理:匯出作業正在進行中
- 失敗:重試後匯出作業失敗,請嘗試將新要求排入佇列
- 已完成:匯出作業已完成,且匯出檔案已可供下載。