ストリーミングドメインのスナップショット設定を構成します。

使用状況ノート

Object Storage Service (OSS) バケットは、ドメインの追加時に選択したライブセンターと同じリージョンに存在する必要があります。 クロスリージョンスナップショットのキャプチャはサポートされていません。

QPS制限

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

デバッグ

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

リクエストパラメーター

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

実行する操作です。 値をAddLiveAppSnapshotConfigに設定します。

AppName String 必須 liveApp

ライブストリームが属するアプリケーションの名前。

DomainName String 必須 example.com

メインのストリーミングドメイン。

OssBucket String 必須 liveBucket ****

スナップショットが保存されているOSSバケットの名前。

OssEndpoint String 必須 oss-cn-shanghai.aliyuncs.com

OSSのエンドポイント。

TimeInterval Integer 必須 5

スナップショットがキャプチャされる間隔。 (単位：秒) 有効な値: 5 ~ 3600

OverwriteOssObject String 任意 {AppName}/{StreamName}.jpg

スナップショットがキャプチャされるたびに上書きされるOSSオブジェクトの名前。

  • 名前の長さは256バイト未満である必要があります。
  • JPGファイルのみがサポートされています。
  • 名前には、{AppName} や {StreamName} などの変数を含めることができます。
SequenceOssObject String 任意 snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

The name of the OSS object, which increments each time when a snapshot is captured. You can call the DescribeLiveStreamSnapshotInfo operation to query OSS objects of a specified period.

  • 名前の長さは256バイト未満である必要があります。
  • JPGファイルのみがサポートされています。
  • The name can contain variables, such as {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}. {UnixTimestamp} と {Sequence} のいずれかを指定する必要があります。
Callback String 任意 https://learn.aliyundoc.com

スナップショットのキャプチャに関するコールバック通知の受信に使用されるURL。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

リクエストの ID です。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=AddLiveAppSnapshotConfig
&AppName=liveApp ****
&DomainNam e=example.com
&OssBucket=liveBucket ****
&OssEndpoin t=oss-cn-shanghai.aliyuncs.com
&TimeInterval=5
&<共通リクエストパラメーター>

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

XML 形式 

<AddLiveAppSnapshotConfigResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</AddLiveAppSnapshotConfigResponse>

JSON 形式 

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

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 InvalidOverwriteOssObjectOrSequenceOssObject. 奇形 指定されたパラメーターOverwriteOssObjectまたはSequenceOssObjectには1が必要です。 OverwriteOssObjectパラメーターもSequenceOssObjectパラメーターも指定されていない場合に返されるエラーメッセージ。
400 InvalidOssBucket.Malformed 指定されたパラメーターOssBucketは無効です。 OSSバケット名の形式が無効な場合に返されるエラーメッセージ。 OssBucketパラメーターの値が有効かどうかを確認します。
400 InvalidOssEndpoint.Malformed 指定されたパラメーターOssEndpointは無効です。 OSSエンドポイントの形式が無効な場合に返されるエラーメッセージ。 OssEndpointパラメーターの値が有効かどうかを確認します。
400 InvalidOverwriteOssObject.Malformed 指定されたパラメーターOverwriteOssObjectは無効です。 指定されたOSSオブジェクト名の形式が無効な場合に返されるエラーメッセージ。 OverwriteOssObjectパラメーターの値が有効かどうかを確認します。
400 InvalidSequenceOssObject.Malformed 指定されたパラメーターSequenceOssObjectは無効です。 指定されたOSSオブジェクト名の形式が無効な場合に返されるエラーメッセージ。 SequenceOssObjectパラメーターの値が有効かどうかを確認します。
400 InvalidOssBucket.NotFound パラメータOssBucketは存在しません。 OSSバケット名の形式が無効な場合に返されるエラーメッセージ。 OssBucketパラメーターの値が有効かどうかを確認します。
400 ConfigAlreadyExists Configはすでに存在しています。 既存のスナップショット構成が見つかった場合に返されるエラーメッセージ。

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