プロダクションスタジオのエピソードリストに関する情報を照会します。

使用状況ノート

この操作は、CreateCaster操作を呼び出すときにNormTypeが0 (プレイリストモード) に設定されているプロダクションスタジオにのみ適用されます。

QPS制限

1人のユーザーが1秒あたり最大4クエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeCasterProgram

実行したい操作。 値をDescribeCasterProgramに設定します。

CasterId String 必須 3463f576-ff9e-4807-be32-b95d5bad ****

制作スタジオのID。 CreateCaster 操作を呼び出したときの応答に含まれます。

RegionId String 任意 cn-shanghai

リージョンの ID
EpisodeId String 任意 1872639A-F203-4EC5-8E43-CB92E68F ****

エピソードのID。
EpisodeType String 任意 リソース

エピソードのタイプ。 設定可能な値は以下のとおりです。

  • Resource: ビデオリソース。
  • Component: コンポーネント。
StartTime String 任意 2016-06-29T09:00:00Z

クエリする時間範囲の先頭。 ISO 8601標準のyyyy-MM-dd T HH:mm:ss Z形式で時刻を指定します。 時刻はUTCである必要があります。

EndTime String 任意 2016-06-29T10:00:00Z

照会する時間範囲の終わり。 ISO 8601標準のyyyy-MM-dd T HH:mm:ss Z形式で時刻を指定します。 時刻はUTCである必要があります。

PageNum Integer 任意 5

返されるページ数。
PageSize Integer 任意 10

各ページで返されるエントリ数。
ステータス Integer 任意 0

エピソードのステータス。 設定可能な値は以下のとおりです。

  • 0: エピソードは再生されていません。
  • 1: エピソードは再生中です。
  • 2: エピソードが再生されました。

レスポンスパラメーター

パラメーター データ型 例 説明
CasterId String 3463f576-ff9e-4807-be32-b95d5bad ****

制作スタジオのID。
エピソード エピソードの配列

照会されたエピソードに関する情報。
エピソード
ComponentId List ["1872639A-F203-4EC5-8E43-CB929282 ****"]

照会されたコンポーネントに関する情報。
EndTime String 2016-06-29T10:02:00Z

データが照会された時間範囲の終わり。 時間は、 Z形式のISO 8601標準に従います。 時刻はUTCで表示されます。
EpisodeId String 1872639A-F203-4EC5-8E43-CB92E68F ****

エピソードのID。
EpisodeName String program_name_1

エピソードの名前。
EpisodeType String リソース

エピソードのタイプ。 設定可能な値は以下のとおりです。

  • Resource: ビデオリソース。
  • Component: コンポーネント。
ResourceId String 1872639A-F203-4EC5-8E43-CB92E837 ****

ビデオリソースのID。
StartTime String 2016-06-29T09:00:00Z

データが照会された時間範囲の開始。 時間は、 Z形式のISO 8601標準に従います。 時刻はUTCで表示されます。
ステータス Integer 0

エピソードのステータス。
SwitchType String TimeFirst

エピソードを切り替えるためのポリシー。 設定可能な値は以下のとおりです。

  • TimeFirst: エピソードは前のエピソードの終了時に開始し、次のエピソードの開始時に終了します。 次のエピソードが存在しない場合、新しいエピソードが追加されるか、制作スタジオが停止するまで、エピソードは繰り返し続けます。 ビデオリソースがライブストリームの場合、このパラメーターはTimeFirstに設定する必要があります。
  • ContentFirst: エピソードは予定通りに開始および終了します。
ProgramEffect Integer 1

カルーセル再生が有効かどうかを示します。

  • 0: カルーセル再生は無効です。
  • 1: カルーセル再生が有効になっています。
プログラム名 String programs_name

カルーセル再生のエピソードリストの名前。
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

リクエストの ID です。
Total Integer 1

返されたエピソードの総数。

例

リクエストの例

https://live.aliyuncs.com/?Action=DescribeCasterProgram
&CasterId=3463f576-ff9e-4807-be32-b95d5bad ****
&<共通リクエストパラメーター>

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

XML 形式 

<DescribeCasterProgramResponse>
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  <ProgramId>1872639A-F203-4EC5-8E43-CB92E68F ****</ProgramId>
  <ProgramName>programs_name</ProgramName>
  <ProgramEffect>1</ProgramEffect>
  <エピソード>
        <EpisodeId>1872639A-F203-4EC5-8E43-CB92E68F ****</EpisodeId>
        <EpisodeType> リソース </EpisodeType>
        <EpisodeName>program_name_1</EpisodeName>
        <ResourceId>1872639A-F203-4EC5-8E43-CB92E837 ****</ResourceId>
        <ComponentIds>1872639A-F203-4EC5-8E43-CB929282 ****</ComponentIds>
        <StartTime>2016-06-29T09:00:00Z</StartTime>
        <EndTime>2016-06-29T10:02:00Z</EndTime>
        <期間> 120</期間>
        <SwitchType>TimeFirst</SwitchType>
  </エピソード>
  <エピソード>
        <EpisodeId>1872639A-F203-4EC5-8E43-CB92E687 ****</EpisodeId>
        <EpisodeType> コンポーネント </EpisodeType>
        <ComponentIds>1872639A-F203-4EC5-8E43-CB625364 ****</ComponentIds>
        <StartTime>2016-06-29T19:02:00Z</StartTime>
        <EndTime>2016-06-29T19:04:00Z</EndTime>
  </エピソード>
</DescribeCasterProgramResponse>

JSON 形式 

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
    "ProgramId": "1872639A-F203-4EC5-8E43-CB92E68F ****" 、
    "ProgramName": "programs_name" 、
    "ProgramEffect":1、
    "エピソード": [
        {
            "EpisodeId": "1872639A-F203-4EC5-8E43-CB92E68F ****" 、
            "EpisodeType": "リソース" 、
            "EpisodeName": "program_name_1" 、
            "ResourceId": "1872639A-F203-4EC5-8E43-CB92E837 ****" 、
            "ComponentIds": [
                "1872639A-F203-4EC5-8E43-CB929282 ****"
            ],
            "StartTime": "2016-06-29T09:00:00Z" 、
            "EndTime": "2016-06-29T10:02:00Z" 、
            "期間": 120、
            "SwitchType": "TimeFirst"
        },
        {
            "EpisodeId": "1872639A-F203-4EC5-8E43-CB92E687 ****" 、
            "EpisodeType": "コンポーネント" 、
            "ComponentIds": [
                "1872639A-F203-4EC5-8E43-CB625364 ****"
            ],
            "StartTime": "2016-06-29T19:02:00Z" 、
            "EndTime": "2016-06-29T19:04:00Z"
        }
    ]
}

エラーコード

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