调用RemoveShowFromShowList删除节目单中的节目。

使用说明

先通过AddShowIntoShowList接口添加节目,再调用本接口删除节目单中的节目。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String RemoveShowFromShowList

系统规定参数。取值:RemoveShowFromShowList

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

需要删除的节目ID列表。

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

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
ShowId String a2b8e671-2fe5-4642-a2ec-bf93880e****

节目ID。

说明 通过查看AddShowIntoShowList接口的返回参数获取ShowId值。
isBatchMode Boolean false

是否批量删除节目。取值:

  • true:批量删除。
  • false:单个删除。
说明 该参数不填,取值为空时,也表示单个删除。

返回数据

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

请求ID。

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

节目ID。

successfulShowIds String f1933f16-5467-4308-b3a9-e8d451a90999

成功删除的节目ID。

failedList String failedList[Show1, Show2...]

删除失败的节目ID列表以及失败信息。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=RemoveShowFromShowList
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&ShowId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<公共请求参数>

正常返回示例

XML格式

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格式

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" ]
}

错误码

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

代码示例


 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("删除导播台节目,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);
    }