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

使用状況ノート

出力されたスナップショットはObject Storage Service (OSS) に保存されます。 変更は、ストリーム取り込みを再開した後に有効になります。

QPS制限

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

デバッグ

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

リクエストパラメーター

パラメーターデータ型必須/任意例：説明
ActionString必須UpdateLiveAppSnapshotConfig

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

AppNameString必須liveApp ****

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

DomainNameString必須example.com

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

TimeIntervalInteger任意5

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

OssEndpointString任意oss-cn-shanghai.aliyuncs.com

OSSのエンドポイント。

OssBucketString任意liveBucket****

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

OverwriteOssObjectString任意{AppName}/{StreamName}.jpg

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

  • 名前の長さは256バイト未満である必要があります。
  • JPGファイルのみがサポートされています。
  • 名前には、{AppName} や {StreamName} などの変数を含めることができます。
  • ハイフン (-) の値は、このパラメーターが削除されたことを示します。
SequenceOssObjectString任意snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

OSSオブジェクトの名前。スナップショットがキャプチャされるたびにインクリメントされます。 DescribeLiveStreamSnapshotInfoを呼び出して、指定された期間のOSSオブジェクトを照会できます。

  • 名前の長さは256バイト未満である必要があります。
  • JPGファイルのみがサポートされています。
  • 名前には、{AppName} 、{StreamName} 、{UnixTimestamp} 、{Sequence} などの変数を含めることができます。 {UnixTimestamp} と {Sequence} のいずれかを指定する必要があります。
  • ハイフン (-) の値は、このパラメーターが削除されたことを示します。
CallbackString任意https://learn.aliyundoc.com

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

レスポンスパラメーター

パラメーターデータ型例：説明
RequestIdString16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

リクエストの ID です。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=UpdateLiveAppSnapshotConfig
&AppName=liveApp****
&DomainNam e=example.com
&<共通リクエストパラメーター>

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

XML 形式

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

JSON 形式

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

エラーコード

HTTP ステータスコードエラーコードエラーメッセージ説明
400InvalidOverwriteOssObjectOrSequenceOssObject. 奇形指定されたパラメーターOverwriteOssObjectまたはSequenceOssObjectには1が必要です。OverwriteOssObjectパラメーターもSequenceOssObjectパラメーターも指定されていない場合に返されるエラーメッセージ。
400InvalidOssEndpoint.Malformed指定されたパラメーターOssEndpointは無効です。OSSエンドポイントの形式が無効な場合に返されるエラーメッセージ。 OssEndpointパラメーターの値が正しいかどうかを確認します。
400InvalidOssBucket.Malformed指定されたパラメーターOssBucketは無効です。OSSバケット名の形式が無効な場合に返されるエラーメッセージ。 OssBucketパラメーターの値が正しいかどうかを確認します。
400InvalidOssBucket.NotFoundパラメータOssBucketは存在しません。OSSバケットが存在しない場合に返されるエラーメッセージ。 OssBucketパラメーターの値が正しいかどうかを確認します。
400InvalidOverwriteOssObject.Malformed指定されたパラメーターOverwriteOssObjectは無効です。指定されたOSSオブジェクト名の形式が無効な場合に返されるエラーメッセージ。 OverwriteOssObjectパラメーターの値が正しいかどうかを確認します。
400InvalidSequenceOssObject.Malformed指定されたパラメーターSequenceOssObjectは無効です。指定されたOSSオブジェクト名の形式が無効な場合に返されるエラーメッセージ。 SequenceOssObjectパラメーターの値が正しいかどうかを確認してください。
400InvalidConfig.NotFoundspeicified configは存在しません。リクエストパラメーターに基づいて設定が見つからない場合に返されるエラーメッセージ。 リクエストパラメーターが正しいかどうかを確認します。

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