Modifies the attributes of an episode list.

Usage notes

This operation allows you to change the position of an episode in an episode list, how many times an episode list is played, and the specific point in time at which the episode of the highest priority in an episode list is played.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyShowList

The operation that you want to perform. Set the value to ModifyShowList.

CasterId String Yes LIVEPRODUCER_POST-cn-0pp1czt****

The ID of the production studio.

  • If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID.
  • If the production studio was created in the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane.
Note You can find the ID of the production studio in the Instance Name column.
ShowId String No a2b8e671-2fe5-4642-a2ec-bf93880e****

The ID of the episode for which you want to change the position in the episode list.

Note You can call the AddShowIntoShowList or DescribeShowList operation and check the value of the response parameter ShowId to obtain the ID.
RepeatTimes Integer No 5

The number of additional times the episode list is played.

Note
  • The RepeatTimes parameter specifies the number of repetitions. For example, if you set the value to 0, the episode list is played once. If you set the value to 1, the episode list is played twice.
  • If you set the value to -1, the episode list is repeated indefinitely.
Spot Integer No 1

The position of the episode in the episode list. Place the ID of the episode for which you want to change the position in the episode list in Spot.

Note The value must be greater than or equal to 0 and less than or equal to the total number of episodes in the episode list.
HighPriorityShowId String No a2b8e671-2fe5-4642-a2ec-bf93880e****

The episode of the highest priority.

Note You can configure this parameter only before the episode list starts.
HighPriorityShowStartTime String No 2021-11-23T12:30:00

The time at which the episode of the highest priority is played. Format: _yyyy-MM-dd'T'HH:mm:ss_.

Note

You can configure this parameter only before the episode list starts.

After you configure this parameter, when the specified point in time is reached, any episode that is playing stops and the episode of the highest priority in the episode list starts to play.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample request

http(s):/live.aliyuncs.com/?Action=ModifyShowList
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<Common request parameters>

Sample success responses

XML format 

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

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

JSON format 

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

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

Error codes

For a list of error codes, visit the API Error Center.

Sample code


 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("The episode list is modified. Response: " + 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);
    }