调用DescribeCasterConfig查询导播台配置信息。

使用说明

先通过CreateCaster接口创建导播台，再调用本接口查询导播台配置信息。

QPS限制

本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeCasterConfig

系统规定参数。取值：DescribeCasterConfig。
CasterId String 是 LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。

  • 如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。

返回数据

名称 类型 示例值 描述
Delay Float 0

延时播放。单位：秒 。

  • 0：禁用延时。
  • 大于0：启用延时。
UrgentLiveStreamUrl String rtmp://demo.aliyundoc.com

备播直播流URL。
UrgentMaterialId String 98646538-bcf9-4aef-bd4a-e6bb76588****

备播视频媒资库素材ID。
UrgentImageId String a089175eb5f4427684fc0715159a****

备播图片媒资库素材ID。
UrgentImageUrl String http://learn.aliyundoc.com/AppName/image.jpg

备播图片素材URL。
CallbackUrl String http://learn.aliyundoc.com/callBackLive

用户回调地址。
ProgramName String program_name

轮播台名称。
CasterName String coco-caster10

导播台名称。
CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。
ProgramEffect Integer 0

轮播生效标志。 取值：

  • 0：不生效 。
  • 1：生效。
ChannelEnable Integer 1

是否启用Channel。 取值：

  • 0：不启用。
  • 1：启用。
DomainName String example.com

主播流域名。
RequestId String 97df6b7f-3490-47d2-ac50-8833e1b64597

请求ID。
SideOutputUrlList String rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****

用户自定义导播台旁路输出地址列表。
SideOutputUrl String rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****

用户自定义导播台旁路输出地址。
TranscodeConfig Object

转码配置。
CasterTemplate String lp_hd

导播台转码模板。取值：

  • lp_ld：流畅。
  • lp_sd：标清。
  • lp_hd：高清。
  • lp_ud：超清。
  • lp_ld_v：竖屏流畅。
  • lp_sd_v：竖屏标清。
  • lp_hd_v：竖屏高清。
  • lp_ud_v：竖屏超清。
LiveTemplateIds Array of String lld

直播转码配置。取值：

  • lsd：标清 。
  • lld：流畅。
  • lud：超清。
  • lhd：高清自适应转码模板 。
  • daobo-lsd：标清。
  • daobo-lld：流畅。
  • daobo-lud：超清。
  • daobo-lhd：高清 。
RecordConfig Object

录制配置参数为空时，表示不启用录制功能。
OssEndpoint String oss-cn-shanghai.aliyundoc.com

存储位置所在OSS节点。
OssBucket String liveBucket****

存储位置。
OnDemand Integer 0

按需录制。取值：

  • 0：关闭。
  • 1：通过HTTP回调方式。
  • 2：解析推流参数按需录制。
  • 7：默认不录制。
RecordFormat Array of RecordFormat

录制格式配置。
RecordFormat
CycleDuration Integer 3600

录制时长。
SliceOssObjectPrefix String record/{liveApp****}/{liveStream****}/{UnixTimestamp****}

切片名称。
OssObjectPrefix String record/{liveApp****}/{liveStream****}

录制文件名。
Format String M3U8

录制格式。
SyncGroupsConfig Array of SyncGroup

存储配置。
SyncGroup
HostResourceId String 28768383240243****

导播台资源ID。
Mode Integer 0

静态页面缓存的模式。取值：

  • 0： 标准模式。
  • 1：强力模式。
  • 2：不缓存。
ResourceIds Array of String 1

需要修改资源组的云资源的资源ID列表，资源ID数量限制为1至50。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeCasterConfig
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeCasterConfigResponse>
<ChannelEnable>1</ChannelEnable>
<RequestId>97df6b7f-3490-47d2-ac50-8833e1b64597</RequestId>
<DomainName>example.com</DomainName>
<UrgentMaterialId>98646538-bcf9-4aef-bd4a-e6bb76588****</UrgentMaterialId>
<TranscodeConfig>
    <CasterTemplate>lp_hd</CasterTemplate>
    <LiveTemplateIds>
        <LocationId>lld</LocationId>
    </LiveTemplateIds>
</TranscodeConfig>
<ProgramName>program_name</ProgramName>
<Delay>0</Delay>
<CallbackUrl>http://learn.aliyundoc.com/callBackLive</CallbackUrl>
<SideOutputUrl>rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****</SideOutputUrl>
<CasterName>coco-caster10</CasterName>
<ProgramEffect>0</ProgramEffect>
<SyncGroupsConfig>
    <SyncGroup>
        <Mode>0</Mode>
        <HostResourceId>28768383240243****</HostResourceId>
        <ResourceIds>
            <ResourceId>1</ResourceId>
        </ResourceIds>
    </SyncGroup>
</SyncGroupsConfig>
<CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>
<RecordConfig>
    <OssEndpoint>oss-cn-shanghai.aliyundoc.com</OssEndpoint>
    <OssBucket>liveBucket****</OssBucket>
    <RecordFormat>
        <RecordFormat>
            <Format>M3U8</Format>
            <SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp****}</SliceOssObjectPrefix>
            <CycleDuration>3600</CycleDuration>
            <OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>
        </RecordFormat>
    </RecordFormat>
</RecordConfig>
</DescribeCasterConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeCasterConfigResponse" : {
    "ChannelEnable" : 1,
    "RequestId" : "97df6b7f-3490-47d2-ac50-8833e1b64597",
    "DomainName" : "example.com",
    "UrgentMaterialId" : "98646538-bcf9-4aef-bd4a-e6bb76588****",
    "TranscodeConfig" : {
      "CasterTemplate" : "lp_hd",
      "LiveTemplateIds" : {
        "LocationId" : "lld"
      }
    },
    "ProgramName" : "program_name",
    "Delay" : 0,
    "CallbackUrl" : "http://learn.aliyundoc.com/callBackLive",
    "SideOutputUrl" : "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
    "CasterName" : "coco-caster10",
    "ProgramEffect" : 0,
    "SyncGroupsConfig" : {
      "SyncGroup" : {
        "Mode" : 0,
        "HostResourceId" : "28768383240243****",
        "ResourceIds" : {
          "ResourceId" : 1
        }
      }
    },
    "CasterId" : "LIVEPRODUCER_POST-cn-0pp1czt****",
    "RecordConfig" : {
      "OssEndpoint" : "oss-cn-shanghai.aliyundoc.com",
      "OssBucket" : "liveBucket****",
      "RecordFormat" : {
        "RecordFormat" : {
          "Format" : "M3U8",
          "SliceOssObjectPrefix" : "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}",
          "CycleDuration" : 3600,
          "OssObjectPrefix" : "record/{liveApp****}/{liveStream****}"
        }
      }
    }
  }
}

错误码

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