调用ModifyShowList修改播单属性_视频直播(LIVE)-阿里云帮助中心

使用说明

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

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ModifyShowList	系统规定参数。取值：ModifyShowList。
CasterId	String	是	LIVEPRODUCER_POST-cn-0pp1czt****	导播台ID。如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。说明直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
ShowId	String	否	a2b8e671-2fe5-4642-a2ec-bf93880e****	需要被修改顺序的节目ID。说明通过查看AddShowIntoShowList或DescribeShowList接口的返回参数获取ShowId值。
RepeatTimes	Integer	否	5	节目单整体播放的循环次数。说明 RepeatTimes为重复次数，示例：0表示重复0次（实际播放1次），1表示重复1次（实际播放2次），以此类推。另外，取值为-1时，表示可无限重复。
Spot	Integer	否	1	播放列表的位置。将需要被修改顺序的节目ID放到Spot的位置。说明取值需大于等于0且小于等于当前节目单总数值。
HighPriorityShowId	String	否	a2b8e671-2fe5-4642-a2ec-bf93880e****	最高优先级节目。说明此配置只能在节目单未开始启动前设置。
HighPriorityShowStartTime	String	否	2021-11-23T12:30:00	最高优先级节目播放时间，格式为：yyyy-MM-dd'T'HH:mm:ss。说明此配置只能在节目单未开始启动前设置。配置完成，节目单会在最高优先级播放时间进行切播，开始播放最高优先级节目（从当前正在播放的节目切播到最高级优先节目）。

返回数据

名称	类型	示例值	描述
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	请求ID。

示例

请求示例

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

正常返回示例

XML格式

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

<ModifyShowListResponse> 
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</ModifyShowListResponse>

JSON格式

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

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

错误码

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

代码示例

 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);
    }