UpdateLiveAppRecordConfig API によるライブ録画設定の更新 - LIVE

出力を Object Storage Service (OSS) に保存するライブストリームの録画設定を更新します。

操作説明

QPS 制限

この操作は、アカウントごとに毎秒 30 回まで呼び出すことができます。この制限を超えたリクエストは破棄され、サービスが中断される可能性があります。

今すぐお試しください

この 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:UpdateLiveAppRecordConfig

*Domain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DomainName	string	必須	メインのストリーミングドメイン。	example.com
AppName	string	必須	ライブストリームの AppName。	liveApp****
OssEndpoint	string	必須	OSS ストレージのエンドポイント。この機能を使用する前に、OSS バケットを作成する必要があります。詳細については、「OSS の設定」をご参照ください。	learn.developer.aliyundoc.com
StreamName	string	任意	ライブストリームの名前。	teststream
StartTime	string	任意	録画開始時刻。フォーマット：yyyy-MM-ddTHH:mm:ssZ (UTC 時間)。説明このパラメーターは、ストリームレベルの録画 (つまり、`StreamName` が指定されている場合) にのみ有効です。時刻は、実際のストリーム開始時刻から 7 日以内でなければなりません。	2018-04-10T09:57:21Z
EndTime	string	任意	録画終了時刻。フォーマット：yyyy-MM-ddTHH:mm:ssZ (UTC 時間)。説明このパラメーターは、ストリームレベルの録画にのみ有効です。`EndTime` と `StartTime` の間隔は 7 日を超えることはできません。	2018-04-16T09:57:21Z
OnDemand	integer	任意	録画モードを指定します。有効な値： 0：オンデマンド録画を無効にします。 1：HTTP コールバックによるオンデマンド録画。 2：アップストリーミング URL のパラメーターを解析することによるオンデマンド録画。 7：手動録画。RealTimeRecordCommand API を呼び出して、手動で録画を開始または停止できます。説明 OnDemand を 1 に設定した場合、AddLiveRecordNotifyConfig API を呼び出して OnDemandUrl パラメーターを設定する必要があります。そうしないと、ApsaraVideo Live はオンデマンド録画を実行しません。	1
DelayTime	integer	任意	中断後に断片化された録画をマージするためのウィンドウ (秒単位)。ストリームがこのウィンドウ内で切断されて再接続された場合、録画は同じファイルで続行されます。有効な値：15～21600。	180
RecordFormat	array<object>	任意	録画の詳細。
	object	任意
CycleDuration	integer	任意	1 回の録画サイクルの期間 (秒単位)。指定しない場合、デフォルト値は 6 時間です。説明ライブストリームが録画サイクル中に中断されても、マージウィンドウ内に通常のストリーミングが再開された場合、録画は同じファイルで続行されます。録画ファイルは、ライブストリームがマージウィンドウより長く中断された場合にのみ生成されます。	1
Format	string	任意	録画フォーマット。有効な値：重要 m3u8 または cmaf を選択した場合は、SliceOssObjectPrefix と SliceDuration も設定する必要があります。RecordFormat または TranscodeRecordFormat の少なくとも 1 つを指定する必要があります。 m3u8 flv mp4 cmaf	m3u8
SliceDuration	integer	任意	1 つのセグメントの期間。単位：秒。説明このパラメーターは、RecordFormat.N.Format パラメーターを m3u8 または cmaf に設定した場合にのみ有効になります。このパラメーターを指定しない場合、デフォルト値の 30 秒が使用されます。有効な値：5～30。	30
TranscodeRecordFormat	array<object>	任意	トランスコードされたストリームの録画設定。
	object	任意
CycleDuration	integer	任意	トランスコードされたストリームの録画サイクル。単位：秒。このパラメーターを指定しない場合、デフォルト値の 6 時間が使用されます。	21600
Format	string	任意	トランスコードされたストリームの録画フォーマット。有効な値：説明 m3u8 または cmaf を選択した場合は、TranscodeRecordFormat.N.SliceOssObjectPrefix および TranscodeRecordFormat.N.SliceDuration パラメーターを指定する必要があります。 m3u8 flv mp4 cmaf	m3u8
SliceDuration	integer	任意	トランスコードされたストリーム録画の 1 つのセグメントの期間。単位：秒。説明このパラメーターは、TranscodeRecordFormat.N.Format パラメーターを m3u8 または cmaf に設定した場合にのみ有効になります。このパラメーターを指定しない場合、デフォルト値の 30 秒が使用されます。有効な値：5～30。	30
TranscodeTemplates	array	任意	トランスコーディングテンプレートグループの詳細。
	string	任意	トランスコーディングテンプレート。一度に最大 10 個のトランスコーディングテンプレートを設定できます。 TranscodeRecordFormat.N.xxx パラメーターを指定する場合は、少なくとも 1 つのトランスコーディングテンプレートを設定します。複数またはすべてのトランスコードされたストリームを録画するには、TranscodeTemplates.1 を ***** (5 つのアスタリスク) に設定します。説明 TranscodeTemplates は、予約済みの識別子である `raw` を渡すことはできません。 TranscodeTemplates.N の .N は、複数のテンプレートを指定するための増分インデックスを表します。例：TranscodeTemplates.1=sd、TranscodeTemplates.2=hd。	sd

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

例

成功レスポンス

JSONJSON

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidOssBucket.Malformed	Specified parameter OssBucket is not valid.
400	InvalidOssBucket.NotFound	The parameter OssBucket does not exist.
400	InvalidFormat.Malformed	Specified parameter Format is not valid.
400	InvalidCycleDuration.Malformed	Specified CycleDuration Format is not valid.
400	InvalidSliceDuration.Malformed	Specified SliceDuration Format is not valid.
400	InvalidTemplateLength.Malformed	Specified record template length is not valid.
400	InvalidTemplate.ForbidRaw	Template named raw is Forbidden.
400	MissingTemplate	Template is mandatory for this action.
400	MissingOssObjectPrefix	OssObjectPrefix is mandatory for this action.
400	MissingSliceOssObjectPrefix	SliceOssObjectPrefix is mandatory for this action.
400	InvalidOssObjectPrefix.Malformed	Specified parameter OssObjectPrefix is not valid.
400	InvalidSliceOssObjectPrefix.Malformed	Specified parameter SliceOssObjectPrefix is not valid.
400	ConfigAlreadyExists	Config has already exist.
400	InvalidFormat.IllegalOperation	Specified parameter Format can not be multiple.
400	InvalidDelayTime	Specified Delaytime is invalid.
400	Live2Vod.ConfigAlreadyExists	Had live2vod record config already.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified EndTime does not math the specified StartTime or current time.
400	InvalidStartTime.Mismatch	Specified StartTime does not math the current time.
400	Forbidden	Ram Permission is forbidden.
400	InvalidOssEndpoint.Malformed	%s, please check and try again later.

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

変更履歴

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