删除节目单中的节目。
接口说明
先通过 AddShowIntoShowList 接口添加节目,再调用本接口删除节目单中的节目。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:RemoveShowFromShowList | get | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
showIdList | array | 否 | 需要删除的节目 ID 组。 | |
string | 否 | 需要删除的节目 ID 列表。 | a2b8e671-2fe5-4642-a2ec-bf93880e**** | |
CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| LIVEPRODUCER_POST-cn-0pp1czt**** |
ShowId | string | 否 | 节目 ID。 说明
通过查看 AddShowIntoShowList 接口的返回参数获取 ShowId 值。
| a2b8e671-2fe5-4642-a2ec-bf93880e**** |
isBatchMode | boolean | 否 | 是否批量删除节目。取值:
说明
该参数不填,取值为空时,也表示单个删除。
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"failedList": "failedList[Show1, Show2...]",
"successfulShowIds": "f1933f16-5467-4308-b3a9-e8d451a90999"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidUserId.Malformed | %s |
400 | InvalidParameter.Malformed | %s |
400 | InvalidCasterId.Malformed | %s |
400 | MissingParameter | %s |
401 | IllegalOperation | %s |
404 | InvalidCaster.NotFound | %s |
404 | InvalidShowList.NotFound | %s |
500 | InternalError | %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 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);
}