調用SubmitLiveSnapshotJob提交實時截圖任務。如果在推流中提交，則會自動異步啟動任務，否則為未啟動狀態。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ice:SubmitLiveSnapshotJob | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| JobName | string | 是 | 任務名稱。
| 截圖任務1 |
| StreamInput | object | 是 | 流輸入信息。 | |
| Url | string | 是 | 流輸入地址。
| rtmp://www.aliyun.com/stream |
| Type | string | 是 | 流輸入類型。目前只支持 rtmp。 | rtmp |
| SnapshotOutput | object | 是 | 截圖輸出信息。 | |
| StorageType | string | 是 | 截圖存儲類型。目前只支持 oss。 | oss |
| Endpoint | string | 是 | 截圖輸出終端。 | oss-cn-shanghai.aliyuncs.com |
| Bucket | string | 是 | 截圖輸出終端的 Bucket。 | testbucket |
| TemplateId | string | 是 | 模板 ID。 | ****a046-263c-3560-978a-fb287782**** |
| CallbackUrl | string | 否 | 截圖回調地址。
| http://www.aliyun.com/snapshot/callback |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****a046-263c-3560-978a-fb287666****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | %s | - |
| 400 | InvalidParameter | %s | - |
| 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. | 賬號未開通智能媒體生產服務。 |
| 404 | TemplateNotFound | No such template. | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | 后臺發生未知錯誤，請稍后重試或聯系客服解決。 |
訪問錯誤中心查看更多錯誤碼。