DescribeShowList - - Alibaba Cloud ドキュメントセンター

使用上の注意

この操作は、空のエピソードリストでは使用できません。 For information about how to add episodes to an episode list, see AddShowIntoShowList.

QPS limit

Alibaba Cloudアカウントを使用して、この操作を呼び出すために1秒あたり最大10件のリクエストを送信できます。 1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。 This may affect your business. この操作を呼び出すときは、制限に注意することをお勧めします。 For more information, see QPS limit on an API operation in ApsaraVideo Live.

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター


パラメーター	データ型	必須	例	説明
操作	文字列	必須	DescribeShowList	実行する操作です。値をDescribeShowListに設定します。
CasterId	String	必須	LIVEPRODUCER_POST-cn-0pp1czt ****	制作スタジオのID。インスタンスがCreateCaster操作を呼び出して作成された場合は、レスポンスパラメーターCasterIdの値を確認してインスタンスIDを取得します。インスタンスがApsaraVideo Liveコンソールで作成された場合、[Production Studio Management] ページでインスタンスIDを取得します。ページに移動するには、ApsaraVideo Liveコンソールにログインし、左側のナビゲーションウィンドウで [Production Studios] をクリックします。注 The value displayed in the Name column for an instance on the Production Studio Management page is the ID of the instance.

レスポンスパラメーター


パラメーター	データ型	例	説明
RequestId	文字列	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	リクエストの ID です。
ショーリスト	文字列	ショーリスト [Show1、Show2、Show3 ..]	Details of the episode list. Showは、特定のエピソードの詳細を示します。詳細については、次の「表示」テーブルをご参照ください。

表示


パラメーター	データ型	説明	例
ShowId	String	エピソードのID。	a2b8e671-2fe5-4642-a2ec-bf93880e ****
期間	String	The duration of the episode. (単位：秒)	20
RepeatTimes	Integer	最初の再生が完了した後にエピソードが繰り返される回数。たとえば、値を0に設定した場合、エピソードは1回再生されます。値を1に設定すると、エピソードは2回再生されます。	5
ResourceInfo	ジェソン	リソースに関する詳細。	次のResourceInfoテーブルをご参照ください。
ShowName	String	エピソードの名前。	liveShow****

ResourceInfo


パラメーター	データ型	説明	例
ResourceType	文字列	リソースのタイプを示します。	vod
ResourceUrl	String	リソースのURL。	`http:// /atestObject .m3u8`
ResourceId	String	ビデオオンデマンド (VOD) ファイルのID。	a2b8e671-2fe5-4642-a2ec-bf93880e ****

例

リクエストの例

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

正常に処理された場合のレスポンス例

XML 形式

<DescribeShowListResponse> 
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  <ショーリスト>
        <ショー>
              <ResourceInfo>
                    <resourceId>a2b8e671-2fe5-4642-a2ec-bf93880e****</resourceId>
                    <resourceUrl>http:// **/atestObject**.m3u8</resourceUrl>
                    <resourceType>vod</resourceType>
              </ResourceInfo>
              <ShowId>a2b8e671-2fe5-4642-a2ec-bf93880e ****</ShowId>
              <期間> 20</期間>
              <RepeatTimes>5</RepeatTimes>
              <ShowName>liveShow ****</ShowName>
        </Shows>
        <Shows>
              <ResourceInfo>
                    <resourceId>a2b8e671-2fe5-4642-a2ec-bf93880e ****</resourceId>
                    <resourceUrl>http://**/atestObject**.m3u8</resourceUrl>
                    <resourceType>pic</resourceType>
              </ResourceInfo>
              <ShowId>a2b8e671-2fe5-4642-a2ec-bf93880e ****</ShowId>
              <期間> 26</期間>
              <ShowName>liveShow2 ****</ShowName>
        </Shows>
        <CurrentShowId>a2b8e671-2fe5-4642-a2ec-bf93880e ****</CurrentShowId>
        <TotalShowListRepeatTimes>1</TotalShowListRepeatTimes>
        <ShowListRepeatTimes>0</ShowListRepeatTimes>
  </ShowList>
</DescribeShowListResponse>

JSON 形式

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
    "ショーリスト": {
        "ショー": [
            {
                "ResourceInfo": {
                    "resourceId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
                    "resourceUrl": "http://**/atestObject **.m3u8" 、
                    "resourceType": "vod"
                },
                "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e ****" 、
                "期間": 20、
                "RepeatTimes": 5、
                "ShowName": "liveShow****"
            },
            {
                "ResourceInfo": {
                    "resourceId": "a2b8e671-2fe5-4642-a2ec-bf93880e ****" 、
                    "resourceUrl": "http://**/atestObject **.m3u8" 、
                    "resourceType": "pic"
                },
                "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e ****" 、
                「期間」: 26、
                "ShowName": "liveShow2 ****"
            }
        ],
        "CurrentShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e ****" 、
        "TotalShowListRepeatTimes": 1,
        「ShowListRepeatTimes」: 0
    }
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。

サンプルコード


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

        CommonRequest describeShowListRequest=新しいCommonRequest();
        describeShowListRequest.setSysDomain("live.aliyuncs.com");
        describeShowListRequest.setSysVersion("2016-11-01");
        describeShowListRequest.setSysAction("DescribeShowList");
        if (casterId != null) {
            describeShowListRequest.putQueryParameter("CasterId" 、casterId);
        }
        CommonResponse describeShowListRequestResponse = client.getCommonResponse(describeShowListRequest);
        System.out.println("エピソードリストのクエリが完了しました。 レスポンスパラメーター: "+ JSON.toJSONString(describeShowListRequestResponse);
        return describeShowListRequestResponse;

    }

public void describeShowList() throws ClientException {
        DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        CommonResponse describeShowListResponse = describeShowList(client, testCasterId);
        文字列data = describeShowListResponse.getData();
        JSONObject jsonObject = JSON.parseObject (データ);
        JSONObject showList = jsonObject.getJSONObject("ShowList");
        JSONArray shows = showList.getJSONArray("Shows");
    
        // エピソードリストの情報を解析します。
        for (int i = 0; i < shows.size(); i ++) {
            JSONObject show = (JSONObject) shows.get(i);
            String showId = show.getString("ShowId");
            String resourceType = show.getString("ResourceType");
            String resourceInfo = show.getString("ResourceInfo");
            Integer repeatTimes = show.getInteger("RepeatTimes");
            Long duration = show.getLong("Duration");
            String showInfo = String.format("show % d: showId: % s \n resourceType: % s \n resourceInfo: % s \n RepeatTimes: % d \n Duration: % d" 、
                    i + 1、showId、resourceType、resourceInfo、repeatTimes、duration);
            System.out.println(showInfo);
        }
    }