DescribeCasterScenes - 查询场景信息列表

查询导播台场景列表。

接口说明

先通过 CreateCaster 接口创建导播台,再调用本接口查询导播台场景列表。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
80787064-1c94-4dc1-85ce-9409960a****
SceneIdstring

场景 ID。

b5f8c837-ceeb-424f-b30b-68e94e86****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CF60DB6A-7FD6-426E-9288-122CC1*****
SceneListarray<object>

场景信息列表。

Sceneobject

场景信息列表。

ComponentIdsarray

组件 id 列表。

componentIdstring

组件 ID 列表。

["1506396160-0-0-7de771a77102680861853af862d5****"]
LayoutIdstring

布局 ID。

37cb2f8b-f152-4338-b928-6704f71d****
OutputTypestring

是否正式输出。 取值:

  • 0:输出 pvw 预览场景。
  • 1:输出 pgm 正式场景。
0
SceneIdstring

场景 ID。可作为更新场景音频配置、查询导播台场景音频配置、启动导播台场景和停止导播台场景的请求参数。

b5f8c837-ceeb-424f-b30b-68e94e86****
SceneNamestring

场景名称。

scene1
Statusinteger

场景状态。 取值:

  • 0:关闭。
  • 1:开启。
0
StreamInfosarray<object>

播放地址列表。

StreamInfoobject

播放地址列表。

OutputStreamUrlstring

播放地址。

http://live/caster/example.net
TranscodeConfigstring

转码配置。取值:

  • sd:标清。
  • lld:流畅。
  • lud:超清。
  • lhd:高清。
lld
VideoFormatstring

格式。取值:

  • flv
  • mp4
  • m3u8
flv
StreamUrlstring

输出流地址。

rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****
Totalinteger

总记录数。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1*****",
  "SceneList": {
    "Scene": [
      {
        "ComponentIds": {
          "componentId": [
            "[\"1506396160-0-0-7de771a77102680861853af862d5****\"]"
          ]
        },
        "LayoutId": "37cb2f8b-f152-4338-b928-6704f71d****",
        "OutputType": "0",
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "SceneName": "scene1",
        "Status": 0,
        "StreamInfos": {
          "StreamInfo": [
            {
              "OutputStreamUrl": "http://live/caster/example.net",
              "TranscodeConfig": "lld",
              "VideoFormat": "flv"
            }
          ]
        },
        "StreamUrl": "rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****"
      }
    ]
  },
  "Total": 2
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史