Operation 包含非同步 API 呼叫的狀態。這個方法會列出符合指定 OperationType 和/或 OperationState 的作業。
方法簽章
public ListOperationsResponse listOperations(ListOperationsRequest request) throws CommonException;
ListOperationsRequest
| 屬性名稱 |
值 |
必填 |
說明 |
operationType |
enum(OperationType) |
否 |
作業類型：CLAIM_DEVICES、UNCLAIM_DEVICES、UPDATE_CLAIMS。 |
state |
enum(OperationState) |
否 |
作業狀態：IN_PROGRESS、COMPLETE、COMPLETE_WITH_ERRORS。 |
pageSize |
int |
否 |
頁面大小，最多 100。如果大於 100 或 null，則使用 100。 |
pageToken |
string |
否 |
網頁權杖。如果為空，系統會傳回第一頁。 |
vendorParams |
map |
否 |
額外欄位，供應商指定的鍵/值組合。 |
ListOperationsResponse
| 屬性名稱 |
值 |
說明 |
operations |
object(Operation) 的清單 |
與要求相符的作業清單。 |
totalCount |
int |
符合要求的裝置總數。 |
nextPageToken |
strong |
下一頁符記。最後一頁為空白。 |
vendorParams |
map |
額外欄位，供應商指定的鍵/值組合。 |
錯誤行為
如果發生錯誤，程式庫會擲回 CommonException，其中包含下列其中一個錯誤代碼：
| 錯誤代碼 |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
NOT_IMPLEMENTED |
