Removes a specified episode from an episode list.

Usage notes

You cannot use this operation on empty episode lists. For information about how to add episodes to an episode list, see AddShowIntoShowList.

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 RemoveShowFromShowList

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

showIdList.N String No a2b8e671-2fe5-4642-a2ec-bf93880e****

The IDs of episodes that you want to remove.

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.

Note You can obtain the ID by checking the value of the response parameter ShowId of the AddShowIntoShowList operation.
isBatchMode Boolean No false

Specifies whether to remove multiple episodes at a time. Valid values:

  • true: removes multiple episodes at a time.
  • false: removes a single episode.
Note If you do not configure this parameter or this parameter is left empty, a single episode is to be removed.

Response parameters

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

The ID of the request.

ShowId String a2b8e671-2fe5-4642-a2ec-bf93880e****

The ID of the episode.

successfulShowIds String f1933f16-5467-4308-b3a9-e8d451a90999

The IDs of episodes that were removed.

failedList String failedList[Show1, Show2...]

The IDs of episodes that failed to be removed and the relevant failure information.

Examples

Sample request

http(s)://live.aliyuncs.com/?Action=RemoveShowFromShowList
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&ShowId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<Common request parameters>

Sample success responses

XML format 

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

<RemoveShowFromShowListResponse>
    <RequestId>001A01C4-3023-57C1-9A82-1BF3DC690C0A</RequestId>
    <failedList>
        <showId>347436b8-c839-4469-a2c0-704c1ce5ce00</showId>
        <failInfo>the showId does not exist in our showOrderList</failInfo>
    </failedList>
    <successfulShowIds>f1933f16-5467-4308-b3a9-e8d451a90999</successfulShowIds>
    <successfulShowIds>547436b8-c839-4469-a2c0-704c1ce5ce00</successfulShowIds>
</RemoveShowFromShowListResponse>

JSON format 

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

{
  "RequestId" : "001A01C4-3023-57C1-9A82-1BF3DC690C0A",
  "failedList" : [ {
    "showId" : "347436b8-c839-4469-a2c0-704c1ce5ce00",
    "failInfo" : "the showId does not exist in our showOrderList"
  } ],
  "successfulShowIds" : [ "f1933f16-5467-4308-b3a9-e8d451a90999", "547436b8-c839-4469-a2c0-704c1ce5ce00" ]
}

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 void removeShowFromShowList(DefaultAcsClient client, String casterId, String showId) throws ClientException {

        CommonRequest removeShowFromShowListFromShowList = new CommonRequest();
        removeShowFromShowListFromShowList.setSysDomain("live.aliyuncs.com");
        removeShowFromShowListFromShowList.setSysVersion("2016-11-01");
        removeShowFromShowListFromShowList.setSysAction("RemoveShowFromShowList");

        removeShowFromShowListFromShowList.putQueryParameter("ShowId", showId);
        removeShowFromShowListFromShowList.putQueryParameter("CasterId", casterId);

        CommonResponse removeShowFromShowListFromShowListResponse = client.getCommonResponse(removeShowFromShowListFromShowList);
        System.out.println("Episodes are removed, removeShowFromShowListFromShowListResponse:" + JSON.toJSONString(removeShowFromShowListFromShowListResponse));
    }


 public void removeShow() throws ClientException {
        String showId = "xxx";
        DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        removeShowFromShowList(client, testCasterId, showId);
    }