ModifyShowList - 修改播单属性

修改播单属性。

接口说明

此接口支持修改单个节目在播单中的位置、播单的整体播放次数以及最高优先级节目的播放固定时间点。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

导播台 ID。

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

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
LIVEPRODUCER_POST-cn-0pp1czt****
ShowIdstring

需要被修改顺序的节目 ID。

说明 通过查看 AddShowIntoShowListDescribeShowList 接口的返回参数获取 ShowId 值。
a2b8e671-2fe5-4642-a2ec-bf93880e****
RepeatTimesinteger

节目单整体播放的循环次数。

说明
  • RepeatTimes 为重复次数,示例:0 表示重复 0 次(实际播放 1 次),1 表示重复 1 次(实际播放 2 次),以此类推。
  • 另外,取值为**-1**时,表示可无限重复。
  • 5
    Spotinteger

    播放列表的位置。将需要被修改顺序的节目 ID 放到 Spot 的位置。

    说明 取值需大于等于 0 且小于等于当前节目单总数值。
    1
    HighPriorityShowIdstring

    最高优先级节目。

    说明 此配置只能在节目单未开始启动前设置。
    a2b8e671-2fe5-4642-a2ec-bf93880e****
    HighPriorityShowStartTimestring

    最高优先级节目播放时间,格式为:yyyy-MM-dd'T'HH:mm:ss。

    说明 此配置只能在节目单未开始启动前设置。
    配置完成,节目单会在最高优先级播放时间进行切播,开始播放最高优先级节目(从当前正在播放的节目切播到最高级优先节目)。
    2021-11-23T12:30:00

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
    }

    错误码

    HTTP status code错误码错误信息
    400InvalidUserId.Malformed%s
    400InvalidParameter.Malformed%s
    400InvalidCasterId.Malformed%s
    400IncorrectCasterStatus%s
    400MissingParameter%s
    401IllegalOperation%s
    404InvalidCaster.NotFound%s
    404InvalidShowList.NotFound%s
    404InvalidShow.NotFound%s
    500InternalError%s

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

    变更历史

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

    代码示例

     public static DefaultAcsClient initClient(String accessKeyId, String accessKeySecret) throws ClientException {
            String regionId = "cn-shanghai";  
            DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
            DefaultAcsClient client = new DefaultAcsClient(profile);
            return client;
        }
    
    
    private static CommonResponse ModfiyShowList(DefaultAcsClient client, String casterId, String showId, Integer repeatTimes, Integer spot,
                                                     String highPriorityShowId, String highPriorityShowStartTime) throws ClientException {
    
            CommonRequest modfiyShowListRequest = new CommonRequest();
            modfiyShowListRequest.setSysDomain("live.aliyuncs.com");
            modfiyShowListRequest.setSysVersion("2016-11-01");
            modfiyShowListRequest.setSysAction("ModifyShowList");
            if (casterId != null) {
                modfiyShowListRequest.putQueryParameter("CasterId", casterId);
            }
            if (showId != null) {
                modfiyShowListRequest.putQueryParameter("ShowId", showId);
            }
            if (repeatTimes != null) {
                modfiyShowListRequest.putQueryParameter("RepeatTimes", repeatTimes.toString());
            }
            if (spot != null) {
                modfiyShowListRequest.putQueryParameter("Spot", spot.toString());
            }
            if (highPriorityShowId != null) {
                modfiyShowListRequest.putQueryParameter("HighPriorityShowId", highPriorityShowId.toString());
            }
            if (highPriorityShowStartTime != null) {
                modfiyShowListRequest.putQueryParameter("HighPriorityShowStartTime", highPriorityShowStartTime.toString());
            }
            CommonResponse modfiyShowListResponse = client.getCommonResponse(modfiyShowListRequest);
            System.out.println("修改 showList 成功,返回值:" + JSON.toJSONString(modfiyShowListResponse));
            return modfiyShowListResponse;
    
        }
    
    public void modifyShowList() throws ClientException {
            DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
            String showId= "";
            Integer repeatTimes=10;
            String highPriorityShowId="";
            String highPriorityShowStartTime = "2021-11-23T12:30:00";
            modfiyShowList(client,testCasterId, showId,repeatTimes,0,highPriorityShowId, highPriorityShowStartTime);
        }