DescribeCasterProgram API リファレンスとパラメータ - LIVE

プロダクションスタジオのプログラムリストを照会します。

操作説明

この操作を呼び出して、プロダクションスタジオのプログラムリストを照会できます。この操作は、ビデオソースとコンポーネントノードをサポートしています。

QPS 制限

1 ユーザーあたりのクエリ/秒 (QPS) 制限は、1 秒あたり 4 呼び出しです。制限を超えた場合、API 呼び出しはスロットルされます。これはビジネスに影響を与える可能性があります。呼び出しはそれに応じて計画してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:DescribeCasterProgram

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョンの ID です。	cn-shanghai
CasterId	string	必須	プロダクションスタジオの ID です。 CreateCaster 操作を呼び出してプロダクションスタジオを作成する場合は、レスポンスで返される CasterId 値を使用します。 [LIVE コンソール] でプロダクションスタジオを作成する場合は、[クラウドプロダクションスタジオ] ページで ID を見つけます。このページに移動するには、[LIVE] > [プロダクションスタジオ] > [クラウドプロダクションスタジオ] を選択します。説明 [クラウドプロダクションスタジオ] ページのリストにあるプロダクションスタジオの名前がその ID です。	LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeId	string	任意	プログラムの ID です。	1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeType	string	任意	ノードのタイプ。有効な値： Resource：ビデオソース。 Component：コンポーネント。	Resource
StartTime	string	任意	開始時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式 (UTC) でなければなりません。	2016-06-29T09:00:00Z
EndTime	string	任意	終了時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式 (UTC) でなければなりません。	2016-06-29T10:00:00Z
PageNum	integer	任意	ページ番号。	5
PageSize	integer	任意	各ページのプログラム数。	10
Status	integer	任意	プログラムのステータス。有効な値： 0：開始されていません 1：再生中 2：終了	0

レスポンスフィールド

フィールド	型	説明	例
	object
CasterId	string	プロダクションスタジオの ID です。	LIVEPRODUCER_POST-cn-0pp1czt****
Episodes	object
Episode	array<object>	ノード。
	array<object>	ノード。
ComponentIds	object
ComponentId	array	コンポーネント ID。
	string	コンポーネント ID。	["1872639A-F203-4EC5-8E43-CB929282****" ]
EndTime	string	終了時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式 (UTC) です。	2016-06-29T10:02:00Z
EpisodeId	string	プログラムの ID です。	1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeName	string	プログラムの名前です。	program_name_1
EpisodeType	string	ノードのタイプ。有効な値： Resource：ビデオソース。 Component：コンポーネント。	Resource
ResourceId	string	ビデオソースの ID です。	1872639A-F203-4EC5-8E43-CB92E837****
StartTime	string	開始時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式 (UTC) です。	2016-06-29T09:00:00Z
Status	integer	プログラムのステータス。	0
SwitchType	string	切り替えポリシー。有効な値： TimeFirst：時間優先。ライブプログラムはこのポリシーのみ使用できます。 ContentFirst：コンテンツ優先。	TimeFirst
ProgramEffect	integer	プログラムリストが有効になっているかどうかを示します。 0：無効 1：有効	1
ProgramName	string	プログラムリストの名前です。	programs_name
RequestId	string	リクエスト ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	返されたエントリの総数。	1

例

成功レスポンス

JSONJSON

{
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "Episodes": {
    "Episode": [
      {
        "ComponentIds": {
          "ComponentId": [
            "[\"1872639A-F203-4EC5-8E43-CB929282****\" ]"
          ]
        },
        "EndTime": "2016-06-29T10:02:00Z",
        "EpisodeId": "1872639A-F203-4EC5-8E43-CB92E68F****",
        "EpisodeName": "program_name_1",
        "EpisodeType": "Resource",
        "ResourceId": "1872639A-F203-4EC5-8E43-CB92E837****",
        "StartTime": "2016-06-29T09:00:00Z",
        "Status": 0,
        "SwitchType": "TimeFirst"
      }
    ]
  },
  "ProgramEffect": 1,
  "ProgramName": "programs_name",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Total": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidPageSize.Malformed	%s, please check and try again later.
400	InvalidPageNum.Malformed	%s, please check and try again later.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.
500	InternalError	%s, please try again later.
500	InvalidParameter.Status	%s, please check and try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。