DescribeLiveSnapshotConfig - 查询域名下的截图配置

查询播流域名下的截图配置。

接口说明

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

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveSnapshotConfigget
*全部资源
*

请求参数

名称类型必填描述示例值
DomainNamestring

主播流域名。

example.com
AppNamestring

直播流所属应用名称。

liveApp****
PageNuminteger

分页的页码。默认值:1

1
PageSizeinteger

每页大小。取值范围:5~30,默认值:10

10
Orderstring

排序。取值:

  • asc(默认值):升序。
  • desc:降序。
asc

返回参数

名称类型描述示例值
object
PageNuminteger

分页的页码。

2
RequestIdstring

请求 ID。

A3136B58-5876-4168-83CA-B562781981A0
Orderstring

排序。

asc
TotalPageinteger

总页数。

10
PageSizeinteger

每页大小。

11
TotalNuminteger

符合条件的总个数。

6
LiveStreamSnapshotConfigListarray<object>

截图配置列表。

LiveStreamSnapshotConfigobject
OverwriteOssObjectstring

覆盖截图存储文件名。

{liveApp****}/{liveStream****}.jpg
TimeIntervalinteger

截图周期。单位:秒。

10
AppNamestring

直播流所属的应用名称。

liveApp****
CreateTimestring

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2016-05-20T01:33:38Z
OssBucketstring

OSS 存储 Bucket 名称。

liveBucket****
DomainNamestring

主播流域名。

example.com
Callbackstring

截图回调地址。

https://learn.aliyundoc.com
SequenceOssObjectstring

实时截图存储文件名。

snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg
OssEndpointstring

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

错误码

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