DescribeLiveSnapshotConfig - 查詢網域名稱下的截圖配置 - ApsaraVideo Live

查詢播流網域名稱下的截圖配置。

介面說明

先擷取主播流網域名稱，再調用本介面查詢播流網域名稱下的截圖配置。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveSnapshotConfig

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DomainName	string	是	主播流網域名稱。	example.com
AppName	string	否	直播流所屬應用程式名稱。	liveApp****
PageNum	integer	否	分頁的頁碼。預設值：1。	1
PageSize	integer	否	每頁大小。取值範圍：5~30，預設值：10。	10
Order	string	否	排序。取值： asc（預設值）：升序。 desc：降序。	asc

返回參數

名稱	類型	描述	樣本值
	object
PageNum	integer	分頁的頁碼。	2
RequestId	string	請求 ID。	A3136B58-5876-4168-83CA-B562781981A0
Order	string	排序。	asc
TotalPage	integer	總頁數。	10
PageSize	integer	每頁大小。	11
TotalNum	integer	合格總個數。	6
LiveStreamSnapshotConfigList	object
LiveStreamSnapshotConfig	array<object>	截圖配置列表。
	object
OverwriteOssObject	string	覆蓋截圖隱藏檔名。	{liveApp**}/{liveStream**}.jpg
TimeInterval	integer	截圖周期。單位：秒。	10
AppName	string	直播流所屬的應用程式名稱。	liveApp****
CreateTime	string	建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2016-05-20T01:33:38Z
OssBucket	string	OSS 儲存 Bucket 名稱。	liveBucket****
DomainName	string	主播流網域名稱。	example.com
Callback	string	截圖回調地址。	https://learn.aliyundoc.com
SequenceOssObject	string	即時截圖隱藏檔名。	snapshot/{liveApp**}/{liveStream**}/{UnixTimestamp}.jpg
OssEndpoint	string	OSS 儲存的 Endpoint 名稱。	cn-oss-****.aliyuncs.com

樣本

正常返回樣本

JSON格式

{
  "PageNum": 2,
  "RequestId": "A3136B58-5876-4168-83CA-B562781981A0",
  "Order": "asc",
  "TotalPage": 10,
  "PageSize": 11,
  "TotalNum": 6,
  "LiveStreamSnapshotConfigList": {
    "LiveStreamSnapshotConfig": [
      {
        "OverwriteOssObject": "{liveApp****}/{liveStream****}.jpg",
        "TimeInterval": 10,
        "AppName": "liveApp****",
        "CreateTime": "2016-05-20T01:33:38Z",
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "Callback": "https://learn.aliyundoc.com",
        "SequenceOssObject": "snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg",
        "OssEndpoint": "cn-oss-****.aliyuncs.com"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。