DescribeCasterConfig - 查询导播台配置 - 视频直播

查询导播台配置信息。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
CasterId	string	是	导播台 ID。如果您通过 CreateCaster 接口创建导播台，请查看 CreateCaster 接口调用返回的参数 CasterId 值。如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。说明直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****

返回参数

名称	类型	描述	示例值
	object	导播台配置信息。
AutoSwitchUrgentConfig	string	自动切备播配置。`eofThres`：表示断流时间后自动切备播，单位为秒。	{"eofThres":3}
AutoSwitchUrgentOn	string	开启断流自动切换备播。 true：开启。 false：关闭。	true
CallbackUrl	string	用户回调地址。	http://learn.aliyundoc.com/callBackLive
CasterId	string	导播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	导播台名称。	coco-caster10
ChannelEnable	integer	是否启用 Channel。取值： 0：不启用。 1：启用。	1
Delay	float	延时播放。单位：秒。 0：禁用延时。大于 0：启用延时。	0
DomainName	string	主播流域名。	example.com
ProgramEffect	integer	轮播生效标志。取值： 0：不生效。 1：生效。	0
ProgramName	string	轮播台名称。	program_name
RecordConfig	object	录制配置参数为空时，表示不启用录制功能。
OnDemand	integer	按需录制。取值： 0：关闭。 1：通过 HTTP 回调方式。 2：解析推流参数按需录制。 7：默认不录制。	0
OssBucket	string	存储位置。	liveBucket****
OssEndpoint	string	存储位置所在 OSS 节点。	oss-cn-shanghai.aliyundoc.com
RecordFormat	array<object>	录制格式配置。
RecordFormat	object	录制时长信息。
CycleDuration	integer	录制时长。	3600
Format	string	录制格式。	M3U8
OssObjectPrefix	string	录制文件名。	record/{liveApp**}/{liveStream**}
SliceOssObjectPrefix	string	切片名称。	record/{liveApp**}/{liveStream}/{UnixTimestamp**}
RequestId	string	请求 ID。	97df6b7f-3490-47d2-ac50-8833e1b64597
SideOutputUrl	string	用户自定义导播台旁路输出地址。	rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
SideOutputUrlList	string	用户自定义导播台旁路输出地址列表。	["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]
SyncGroupsConfig	array<object>	存储配置。
SyncGroup	object	存储配置。
HostResourceId	string	导播台资源 ID。	28768383240243****
Mode	integer	静态页面缓存的模式。取值： 0：标准模式。 1：强力模式。 2：不缓存。	0
ResourceIds	array	需要修改资源组的云资源的资源 ID 列表，资源 ID 数量限制为 1 至 50。
ResourceId	string	需要修改资源组的云资源的资源 ID 列表，资源 ID 数量限制为 1 至 50。	1
TranscodeConfig	object	转码配置。
CasterTemplate	string	导播台转码模板。取值： lp_ld：流畅。 lp_sd：标清。 lp_hd：高清。 lp_ud：超清。 lp_ld_v：竖屏流畅。 lp_sd_v：竖屏标清。 lp_hd_v：竖屏高清。 lp_ud_v：竖屏超清。	lp_hd
LiveTemplateIds	array	直播转码配置。
LocationId	string	直播转码配置。取值： lsd：标清。 lld：流畅。 lud：超清。 lhd：高清自适应转码模板。 daobo-lsd：标清。 daobo-lld：流畅。 daobo-lud：超清。 daobo-lhd：高清。	lld
UrgentImageId	string	备播图片媒资库素材 ID。	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	备播图片素材 URL。	http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrl	string	备播直播流 URL。	rtmp://demo.aliyundoc.com
UrgentMaterialId	string	备播视频媒资库素材 ID。	98646538-bcf9-4aef-bd4a-e6bb76588****

示例

正常返回示例

JSON格式

{
  "AutoSwitchUrgentConfig": "{\"eofThres\":3}",
  "AutoSwitchUrgentOn": "true",
  "CallbackUrl": "http://learn.aliyundoc.com/callBackLive",
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "CasterName": "coco-caster10",
  "ChannelEnable": 1,
  "Delay": 0,
  "DomainName": "example.com",
  "ProgramEffect": 0,
  "ProgramName": "program_name",
  "RecordConfig": {
    "OnDemand": 0,
    "OssBucket": "liveBucket****",
    "OssEndpoint": "oss-cn-shanghai.aliyundoc.com",
    "RecordFormat": {
      "RecordFormat": [
        {
          "CycleDuration": 3600,
          "Format": "M3U8",
          "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
          "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}"
        }
      ]
    }
  },
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
  "SideOutputUrl": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
  "SideOutputUrlList": "[\"rtmp://domain/app1/stream1\",\"rtmp://domain/app2/stream2\"]",
  "SyncGroupsConfig": {
    "SyncGroup": [
      {
        "HostResourceId": "28768383240243****",
        "Mode": 0,
        "ResourceIds": {
          "ResourceId": [
            "1"
          ]
        }
      }
    ]
  },
  "TranscodeConfig": {
    "CasterTemplate": "lp_hd",
    "LiveTemplateIds": {
      "LocationId": [
        "lld"
      ]
    },
    "CustomParams": {
      "video": {
        "fps": 0,
        "bitrate": 0,
        "width": 0,
        "height": 0
      }
    }
  },
  "UrgentImageId": "a089175eb5f4427684fc0715159a****",
  "UrgentImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
  "UrgentLiveStreamUrl": "rtmp://demo.aliyundoc.com",
  "UrgentMaterialId": "98646538-bcf9-4aef-bd4a-e6bb76588****"
}

错误码

HTTP status code	错误码	错误信息
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
500	InternalError	%s

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

变更历史

变更时间	变更内容概要	操作
2023-11-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-31	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情