AddLiveAppSnapshotConfig - - Alibaba Cloud ドキュメントセンター

操作説明

この操作を呼び出す前に、ApsaraVideo Live のライブストリーミングスナップショットの課金方法と料金を十分に理解していることを確認してください。詳細については、「ライブストリーミングスナップショットの課金」をご参照ください。
Object Storage Service (OSS) が有効化され、特定のバケットが作成されていることを確認してください。これにより、ApsaraVideo Live はライブストリーミングスナップショットをバケットに保存できます。詳細については、「OSS の設定」をご参照ください。
スナップショットを OSS に保存すると、ストレージ料金が発生します。詳細については、「ストレージ料金」をご参照ください。
OSS バケットは、ストリーミングドメインのライブセンターと同じリージョンに存在する必要があります。リージョン間のスナップショット取得はサポートされていません。

QPS 制限

1 つのアカウントで、この操作は 1 秒あたり最大 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:AddLiveAppSnapshotConfig

create

*Domain

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DomainName	string	必須	メインのストリーミングドメイン。	example.com
AppName	string	必須	ライブストリームが属するアプリケーションの名前。このパラメーターの値は、アップストリーミング URL のアプリケーション名と同じである必要があります。そうでない場合、設定は有効になりません。名前は最大 255 文字で、数字、文字、ハイフン (-)、アンダースコア (_) を含めることができます。名前をハイフン (-) またはアンダースコア (_) で始めることはできません。また、アスタリスク (*) を値として指定して、すべてのアプリケーションに一致させることもできます。	liveApp****
TimeInterval	integer	必須	スナップショットを取得する間隔。単位：秒。有効な値の範囲：5～3600。	5
OssEndpoint	string	必須	OSS バケットのエンドポイント。設定が完了すると、コールバック情報に基づいて OSS コンソールで特定のスナップショットを検索できます。事前に OSS エンドポイントを設定する必要があります。詳細については、「OSS の設定」をご参照ください。	cn-oss-****.aliyuncs.com
OssBucket	string	必須	OSS バケットの名前。設定が完了すると、コールバック情報に基づいて OSS コンソールで特定のスナップショットを検索できます。事前に OSS バケットを作成する必要があります。詳細については、「OSS の設定」をご参照ください。	liveBucket****
OverwriteOssObject	string	任意	上書きモードで保存されるスナップショットの命名形式です。これは、新しいスナップショットが以前のスナップショットを上書きすることを意味します。名前の長さは 256 バイト未満である必要があります。 JPG イメージのみがサポートされています。名前には、{AppName} や {StreamName} などの変数を含めることができます。	{AppName}/{StreamName}.jpg
SequenceOssObject	string	任意	シーケンスで保存されるスナップショットの命名形式です。これは、新しいスナップショットが以前のスナップショットを上書きしないことを意味します。DescribeLiveStreamSnapshotInfo 操作を呼び出して、特定の期間内に取得されたスナップショットをクエリできます。名前の長さは 256 バイト未満である必要があります。 JPG イメージのみがサポートされています。名前には、{AppName}、{StreamName}、{UnixTimestamp}、{Sequence} などの変数を含めることができます。名前には、{UnixTimestamp} と {Sequence} の変数のうち少なくとも 1 つを含める必要があります。	snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
Callback	string	任意	スナップショット取得に関する通知を受信するためのコールバック URL。	https://learn.aliyundoc.com

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidOverwriteOssObjectOrSequenceOssObject.Malformed	Specified paramters OverwriteOssObject or SequenceOssObject should have one.
400	InvalidOssBucket.Malformed	Specified parameter OssBucket is not valid.
400	InvalidOssEndpoint.Malformed	Specified parameter OssEndpoint is not valid.
400	InvalidOverwriteOssObject.Malformed	Specified parameter OverwriteOssObject is not valid.
400	InvalidSequenceOssObject.Malformed	Specified parameter SequenceOssObject is not valid.
400	InvalidOssBucket.NotFound	The parameter OssBucket does not exist.
400	ConfigAlreadyExists	Config has already exist.

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

変更履歴

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