配置截圖信息。輸出內(nèi)容保存到OSS中,重新推流即生效。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
live:AddLiveAppSnapshotConfig | create | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 主播流域名。 | example.com |
AppName | string | 是 | 播流所屬應用名稱。 AppName 名稱與推流地址中的 AppName 名稱對應,模板才能生效。不超過 255 字符,支持數(shù)字、大小寫字母、短橫線(-)、下劃線(_),短橫線、下劃線不能位于首位。也支持取值為單個星號(*)字符,即可匹配所有 AppName。 | liveApp**** |
TimeInterval | integer | 是 | 截圖周期,每個間隔周期截一次圖片。單位:秒。取值范圍:5~3600。 | 5 |
OssEndpoint | string | 是 | OSS 存儲的 Endpoint 名稱。 配置完成后,您可以根據(jù)配置回調(diào)信息,在 OSS 控制臺查找指定的配置內(nèi)容。OSS Endpoint 需要提前創(chuàng)建,創(chuàng)建方法請參考配置 OSS 。 | cn-oss-****.aliyuncs.com |
OssBucket | string | 是 | OSS 存儲的 Bucket 名稱。 配置完成后,您可以根據(jù)配置回調(diào)信息,在 OSS 控制臺查找指定的配置內(nèi)容。OSS Bucket 需要提前創(chuàng)建,創(chuàng)建方法請參考配置 OSS 。 | liveBucket**** |
OverwriteOssObject | string | 否 | 覆蓋截圖存儲文件名。每次截圖都覆蓋此文件。
| {AppName}/{StreamName}.jpg |
SequenceOssObject | string | 否 | 實時截圖存儲文件名。 每次截圖都遞增存儲,調(diào)用 DescribeLiveStreamSnapshotInfo 接口可以查詢某一段時間的截圖文件。
| snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg |
Callback | string | 否 | 截圖回調(diào)地址。 | https://learn.aliyundoc.com |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidOverwriteOssObjectOrSequenceOssObject.Malformed | Specified paramters OverwriteOssObject or SequenceOssObject should have one. | OverwriteOssObject與SequenceOssObject參數(shù)任選其一。 |
400 | InvalidOssBucket.Malformed | Specified parameter OssBucket is not valid. | OSSBucket參數(shù)錯誤,請您確認該OSS BUCKET參數(shù)是否正確。 |
400 | InvalidOssEndpoint.Malformed | Specified parameter OssEndpoint is not valid. | OSSEndpoint參數(shù)錯誤,請您確認該OSSEndpoint參數(shù)是否正確。 |
400 | InvalidOverwriteOssObject.Malformed | Specified parameter OverwriteOssObject is not valid. | OverwriteOSSObject參數(shù)錯誤,請您確認該OverwriteOSSObject參數(shù)是否正確。 |
400 | InvalidSequenceOssObject.Malformed | Specified parameter SequenceOssObject is not valid. | SequenceOssObject參數(shù)錯誤,請您確認該SequenceOssObject參數(shù)是否正確。 |
400 | InvalidOssBucket.NotFound | The parameter OssBucket does not exist. | OSSBucket參數(shù)錯誤,請您確認該OSS BUCKET參數(shù)是否正確。 |
400 | ConfigAlreadyExists | Config has already exist. | 配置已添加。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|