查询直播截图配置 - API参考| 阿里云

使用说明

先获取主播流域名，再调用本接口查询播流域名下的截图配置。

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****"
            }
        }
    }
}

错误码

访问错误中心查看更多错误码。