呼叫 ListLiveSnapshotJobs 取得即時截圖任務清單,可分頁取得。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ice:ListLiveSnapshotJobs |
*全部資源。
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| StartTime |
string |
否 |
查詢開始時間。UTC 時間,格式:yyyy-MM-ddTHH:mm:ssZ。
|
2022-02-02T00:00:00Z |
| EndTime |
string |
否 |
查詢結束時間。UTC 時間,格式:yyyy-MM-ddTHH:mm:ssZ。
|
2022-02-02T23:59:59Z |
| SearchKeyWord |
string |
否 |
搜尋關鍵字,任務 ID/名稱,名稱支援模糊搜尋。
|
****a046-263c-3560-978a-fb287782**** |
| Status |
string |
否 |
任務狀態篩選,預設查詢全部。 枚舉值:
|
|
| PageNo |
integer |
否 |
頁碼,[1, n),預設為 1。 |
1 |
| PageSize |
integer |
否 |
每頁筆數,[1, 100],預設為 10。 |
10 |
| SortBy |
string |
否 |
排序,按 CreateTime 排序,預設為 desc。 枚舉值:
|
desc |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資料。 |
||
| RequestId |
string |
請求 ID。 |
******11-DB8D-4A9A-875B-275798****** |
| JobList |
array<object> |
任務清單。 |
|
|
array<object> |
|||
| JobId |
string |
任務 ID。 |
****a046-263c-3560-978a-fb287782**** |
| JobName |
string |
任務名稱。 |
Screenshot task1 |
| TemplateId |
string |
範本 ID。 |
****a046-263c-3560-978a-fb287666**** |
| TemplateName |
string |
範本名稱。 |
Template 1 |
| Status |
string |
任務狀態。 枚舉值:
|
started |
| SnapshotOutput |
object |
輸出資訊。 |
|
| StorageType |
string |
儲存類型,目前僅支援 oss。 |
oss |
| Endpoint |
string |
輸出端點,type=oss 時返回 OSS 網域。 |
oss-cn-shanghai.aliyuncs.com |
| Bucket |
string |
輸出端點的 Bucket,type=oss 時返回 OSS Bucket。 |
testbucket |
| TimeInterval |
integer |
截圖時間間隔,單位:秒。 |
5 |
| CreateTime |
string |
建立時間。 |
2022-07-20T02:48:58Z |
| PageNo |
integer |
頁碼。 |
1 |
| PageSize |
integer |
每頁筆數。 |
10 |
| SortBy |
string |
排序。 |
desc |
| TotalCount |
integer |
總數。 |
100 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobList": [
{
"JobId": "****a046-263c-3560-978a-fb287782****",
"JobName": "Screenshot task1",
"TemplateId": "****a046-263c-3560-978a-fb287666****",
"TemplateName": "Template 1",
"Status": "started",
"SnapshotOutput": {
"StorageType": "oss",
"Endpoint": "oss-cn-shanghai.aliyuncs.com",
"Bucket": "testbucket"
},
"TimeInterval": 5,
"CreateTime": "2022-07-20T02:48:58Z"
}
],
"PageNo": 1,
"PageSize": 10,
"SortBy": "desc",
"TotalCount": 100
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MissingParameter | %s | |
| 400 | InvalidParameter | %s | |
| 400 | MalformedStartTime | Specified parameter StartTime is not valid. | |
| 400 | MalformedEndTime | Specified parameter EndTime is not valid. | |
| 400 | EndTimeMismatch | Specified end time does not math the specified start time. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | UserDisable | User is disable. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. | |
| 403 | OperationDenied | Your account has not enabled the ICE service. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。