ApsaraVideo Live:AddShowIntoShowList

Usage notes

You must create a production studio in the new playlist mode and add media resources to the production studio before you can call this operation. For information about how to create a production studio by calling an operation, see CreateCaster.

You can add up to 1,000 episodes to an episode list.

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 limits.

Request parameters

Response parameters

Examples

Sample requests

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

Sample success responses

XML format

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

<AddShowIntoShowListResponse>
    <RequestId>987DA143-A39C-5B5D-AF5B-3B07944A0036</RequestId>
    <failedList>
        <show>
            <resourceUrl>test</resourceUrl>
            <resourceType>vod</resourceType>
        </show>
        <failInfo>ResourceUrl is invalid, probe failed</failInfo>
    </failedList>
    <failedList>
        <show>
            <resourceUrl>http://error.test.case</resourceUrl>
            <resourceType>vod</resourceType>
        </show>
        <failInfo>ResourceUrl is invalid, probe failed</failInfo>
    </failedList>
    <successfulShowIds>f1933f16-5467-4308-b3a9-e8d451a90999, 547436b8-c839-4469-a2c0-704c1ce5ce00</successfulShowIds>
</AddShowIntoShowListResponse>

JSON format

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

{
  "RequestId" : "987DA143-A39C-5B5D-AF5B-3B07944A0036",
  "failedList" : [ {
    "show" : {
      "resourceUrl" : "test",
      "resourceType" : "vod"
    },
    "failInfo" : "ResourceUrl is invalid, probe failed"
  }, {
    "show" : {
      "resourceUrl" : "http://error.test.case",
      "resourceType" : "vod"
    },
    "failInfo" : "ResourceUrl is invalid, probe failed"
  } ],
  "successfulShowIds" : "f1933f16-5467-4308-b3a9-e8d451a90999, 547436b8-c839-4469-a2c0-704c1ce5ce00"
}

Error codes

For a list of error codes, see Service error codes.

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 addShowIntoShowList(DefaultAcsClient client, String showName, String resourceId, String resourceUrl,
                                                      String resourceType, Integer spot, Integer repeatTimes,
                                                      String casterId, Long duration) throws ClientException {
        CommonRequest addShowIntoShowListRequest = new CommonRequest();
        addShowIntoShowListRequest.setSysDomain("live.aliyuncs.com");
        addShowIntoShowListRequest.setSysVersion("2016-11-01");
        addShowIntoShowListRequest.setSysAction("AddShowIntoShowList");
        if (casterId == null || resourceType == null) {
            return null;
        }
        if (resourceId == null && resourceUrl == null) {
            return null;
        }
        addShowIntoShowListRequest.putQueryParameter("CasterId", casterId);
        addShowIntoShowListRequest.putQueryParameter("ResourceType", resourceType);
        if (showName != null) {
            addShowIntoShowListRequest.putQueryParameter("ShowName", showName);
        }
        if (resourceUrl != null) {
            addShowIntoShowListRequest.putQueryParameter("ResourceUrl", resourceUrl);
        }
        if (resourceId != null) {
            addShowIntoShowListRequest.putQueryParameter("ResourceId", resourceId);
        }
        if (spot != null) {
            addShowIntoShowListRequest.putQueryParameter("Spot", spot.toString());
        }
        if (repeatTimes != null) {
            addShowIntoShowListRequest.putQueryParameter("RepeatTimes", repeatTimes.toString());
        }
        if (duration != null) {
            addShowIntoShowListRequest.putQueryParameter("Duration", duration.toString());
        }
        CommonResponse addShowIntoShowListResponse = client.getCommonResponse(addShowIntoShowListRequest);
        return addShowIntoShowListResponse;
    }
    public void addshows() throws ClientException {
        DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        String[] resourceIds = new String[]{"698d2b23581f476ea71107703e647d1e", "9c97e83e211a435b9f797e4e20eeea27", "76c6addaa41c438985666a8a964fa5e5"};
        for (int i = 0; i < resourceIds.length; i++) {
            String showName = "ShowName#" + i;
            Integer repeatTimes = i;
            addShowIntoShowList(client, showName, resourceIds[i], null, "vod", null, repeatTimes, testCasterId, null);
        }
    }