制作スタジオに関する情報を照会します。

使用状況ノート

この操作を呼び出す前に、制作スタジオが作成されている必要があります。

QPS制限

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

デバッグ

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

リクエストパラメーター

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

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

CasterId String 任意 48e95adf-580b-4661-9ee9-6fbc6 ******

制作スタジオのID。

CreateCaster インターフェイスを使用して制作スタジオを作成する場合は、レスポンスのCasterIdパラメーターの値を確認します。

ApsaraVideo Live Consoleを使用して制作スタジオを作成する場合は、コンソールにログインし、次のパスを使用して制作スタジオのIDを確認します。

制作スタジオ > 制作スタジオ管理

注 CasterIdは、Production Studio Managementページの [名前] 列に反映されます。
CasterName String 任意 liveCaster ****

制作スタジオの名前。
StartTime String 任意 2016-06-29T09:00:00Z

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

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

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

PageNum Integer 任意 1

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

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

制作スタジオのステータス。 設定可能な値は以下のとおりです。

  • 0: idle.
  • 1: streaming.

レスポンスパラメーター

パラメーター データ型 例 説明
CasterList キャスターの配列

各制作スタジオに関する情報。
キャスター
CasterId String 48e95adf-580b-4661-9ee9-6fbc6e ******

制作スタジオのID。
CasterName String liveCaster ****

制作スタジオの名前。
CasterTemplate String lp_ld

制作スタジオがビデオを再生する解像度。 このパラメータは、サブスクリプション制作スタジオに必要です。 設定可能な値は以下のとおりです。

  • lp_ld: 制作スタジオは低解像度でビデオを再生します。
  • lp_sd: 制作スタジオは標準定義でビデオを再生します。
  • lp_hd: 制作スタジオは高解像度でビデオを再生します。
  • lp_ud: 制作スタジオは超高解像度でビデオを再生します。
  • lp_ld_v: 制作スタジオは、低解像度とポートレートモードでビデオを再生します。
  • lp_sd_v: 制作スタジオは、標準定義とポートレートモードでビデオを再生します。
  • lp_hd_v: 制作スタジオは、高解像度とポートレートモードでビデオを再生します。
  • lp_ud_v: 制作スタジオは、超高解像度とポートレートモードでビデオを再生します。
ChannelEnable Integer 1

プロダクションスタジオでチャンネルが有効になっているかどうかを示します。

  • 0: チャンネルは無効です。
  • 1: チャンネルは有効です。
ChargeType String PrePaid

制作スタジオの課金方法。 現在、従量課金のみがサポートされています。 有効な値:

  • PrePaid: サブスクリプション。
  • PostPaid ： 従量課金。
CreateTime String 2017-08-30 12:02:57.0

制作スタジオが作成された時間。
ExpireTime String 2018-08-30 12:02:57.0

制作スタジオの有効期限。
NormType Integer 1

制作スタジオのタイプ。 設定可能な値は以下のとおりです。

  • 0: 近いVODモード。
  • 1: スタジオモード。
PurchaseTime String 2017-08-30 12:02:57.0

制作スタジオが購入された時間。
StartTime String 2017-08-30 18:02:57.0

現在のストリーミングの開始時刻。 このパラメーターは、制作スタジオがストリーミング中のときに返されます。
ステータス Integer 1

制作スタジオのステータス。 設定可能な値は以下のとおりです。

  • 0: idle.
  • 1: streaming.
RequestId String 6159ba01-6687-4fb2-a831-f0cd8d188648

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

返された制作スタジオの総数。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeCasters
&<共通リクエストパラメーター>

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

XML 形式 

<DescribeCastersResponse>
  <RequestId>D81E449E-6420-42A3-8525-BCCB6E87323F</RequestId>
  <Total>1</Total>
  <CasterList>
        <キャスター>
              <ステータス> 0</ステータス>
              <CasterName>liveCaster ****</CasterName>
              <ChannelEnable>1</ChannelEnable>
              <ChargeType>PostPaid</ChargeType>
              <CreateTime>2019-05-23T12:31:48Z</CreateTime>
              <NormType>0</NormType>
              <CasterId>48e95adf-580b-4661-9ee9-6fbc6e ******</CasterId>
        </キャスター>
  </CasterList>
</DescribeCastersResponse>

JSON 形式 

{
    "RequestId": "D81E449E-6420-42A3-8525-BCCB6E87323F" 、
    "合計": 1、
    "CasterList": {
        "キャスター": [
            {
                "Status": 0,
                "CasterName": "liveCaster ****" 、
                "ChannelEnable": 1、
                "ChargeType": "PostPaid" 、
                "CreateTime": "2019-05-23T12:31:48Z" 、
                "NormType": 0、
                "CasterId": "48e95adf-580b-4661-9ee9-6fbc6e ******"
            }
        ]
    }
}

エラーコード

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