DescribeLivePackageConfig API リファレンス - LIVE - Alibaba Cloud - ApsaraVideo Live

ストリーミングドメインのライブパッケージング設定を照会します。

操作説明

まずメインのストリーミングドメインを取得してから、このオペレーションを呼び出してストリーミングドメインのライブパッケージング設定を照会します。

QPS 制限

このオペレーションのシングルユーザーQPS 制限は、1 分あたり300 回の呼び出しです。制限を超えた場合、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:DescribeLivePackageConfig

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョンID。	cn-shanghai
DomainName	string	必須	ライブストリーミングドメイン（メインの再生ドメイン）。	example.com
AppName	string	任意	アプリ名。すべてのアプリ名に一致させるには空のままにします。	AppName
StreamName	string	任意	ライブストリーム名。すべてのストリーム名に一致させるには空のままにします。	StreamName
PageNum	integer	任意	現在のページ番号。デフォルト値：1。	1
PageSize	integer	任意	ページサイズ。デフォルト値：10。有効値：5～30。	10
Order	string	任意	ソート順。有効値： asc（デフォルト）：昇順。 desc：降順。列挙値: asc : 昇順 desc : 降順	asc

レスポンスフィールド

フィールド	型	説明	例
	object	パッケージング設定情報。
LivePackageConfigList	object
LivePackageConfig	array<object>	パッケージング設定リスト。
	object	パッケージング設定リスト。
AppName	string	ライブストリームの AppName。	AppName
DomainName	string	メインストリーミングドメイン。	example.com
IgnoreTranscode	boolean	トランスコードされたストリームを無視するかどうかを示します。有効な値： true (デフォルト)：無視します。 false：無視しません。	true
PartDuration	integer	Part (部分的なセグメント) の期間。単位：ミリ秒。	0
Protocol	string	ライブストリーミングプロトコルとコンテナフォーマット。	HLS_CMAF
SegmentDuration	integer	セグメントの長さ (秒単位)。	5
SegmentNum	integer	ライブ M3U8 マニフェスト内のセグメント数。	3
StreamName	string	ストリーム名。	StreamName
Order	string	ソート順。有効値： asc（デフォルト）：昇順。 desc：降順。	asc
PageNum	integer	現在のページ番号。	1
PageSize	integer	ページサイズ。	10
RequestId	string	リクエストID。	1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0
TotalNum	integer	レコードの合計数。	1
TotalPage	integer	ページの合計数。	10

例

成功レスポンス

JSONJSON

{
  "LivePackageConfigList": {
    "LivePackageConfig": [
      {
        "AppName": "AppName",
        "DomainName": "example.com",
        "IgnoreTranscode": true,
        "PartDuration": 0,
        "Protocol": "HLS_CMAF",
        "SegmentDuration": 5,
        "SegmentNum": 3,
        "StreamName": "StreamName"
      }
    ]
  },
  "Order": "asc",
  "PageNum": 1,
  "PageSize": 10,
  "RequestId": "1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0",
  "TotalNum": 1,
  "TotalPage": 10
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParam	%s, please check and try again later.
400	InvalidParams	%s, please check and try again later.
400	ConfigAlreadyExists	%s Please check and try again later.
400	InvalidProtocol	%s, please check and try again later.
400	InvalidSegmentNum	%s, please check and try again later.
400	InvalidSegmentDuration	%s, please check and try again later.
400	InvalidPartDuration	%s, please check and try again later.
500	InternalErr	%s, please try again.

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

変更履歴

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