調用DescribeLiveSnapshotConfig查詢播流域名下的截圖配置。

使用說明

先獲取主播流域名，再調用本接口查詢播流域名下的截圖配置。

QPS限制

本接口的單用戶QPS限制為100次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeLiveSnapshotConfig

系統規定參數。取值：DescribeLiveSnapshotConfig。

DomainName String 是 example.com

主播流域名。
AppName String 否 liveApp****

直播流所屬應用名稱。
PageNum Integer 否 1

分頁的頁碼。默認值：1。

PageSize Integer 否 10

每頁大小。取值范圍：5~30，默認值：10。

Order String 否 asc

排序。取值：

  • asc（默認值）：升序。
  • desc：降序。

返回數據

名稱 類型 示例值 描述
RequestId String A3136B58-5876-4168-83CA-B562781981A0

請求ID。
LiveStreamSnapshotConfigList Array of LiveStreamSnapshotConfig

截圖配置列表。
LiveStreamSnapshotConfig
DomainName String example.com

主播流域名。
AppName String liveApp****

直播流所屬的應用名稱。
TimeInterval Integer 10

截圖周期。單位：秒。
CreateTime String 2016-05-20T01:33:38Z

創建時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

Callback String https://learn.aliyundoc.com

截圖回調地址。
OssBucket String liveBucket****

OSS存儲Bucket名稱。
OssEndpoint String cn-oss-****.aliyuncs.com

OSS存儲的Endpoint名稱。
OverwriteOssObject String {liveApp****}/{liveStream****}.jpg

覆蓋截圖存儲文件名。
SequenceOssObject String snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg

實時截圖存儲文件名。
PageNum Integer 2

分頁的頁碼。
PageSize Integer 11

每頁大小。
Order String asc

排序。
TotalPage Integer 10

總頁數。
TotalNum Integer 6

符合條件的總個數。

示例

請求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveSnapshotConfig
&DomainName=example.com
&<公共請求參數>

正常返回示例

XML格式 

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

JSON格式 

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

錯誤碼

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