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