調用ListLiveSnapshotJobs獲取實時截圖任務列表,可分頁獲取。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
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 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobList": [
{
"JobId": "****a046-263c-3560-978a-fb287782****",
"JobName": "截圖任務1",
"TemplateId": "****a046-263c-3560-978a-fb287666****",
"TemplateName": "模板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. | - |
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. | 賬號未開通智能媒體生產服務。 |
500 | InternalError | The request processing has failed due to some unknown error. | 后臺發生未知錯誤,請稍后重試或聯系客服解決。 |
訪問錯誤中心查看更多錯誤碼。