リクエストパラメータと設定例の説明 - ApsaraVideo VOD - Alibaba Cloud ドキュメントセンター

このトピックでは、ApsaraVideo VOD API操作のリクエストパラメーターとして、PlayConfig、ReAuthInfo、UserData、SpriteSnapshotConfig、EncryptConfigについて説明します。このトピックでは、パラメーターの設定方法の例も示します。

PlayConfig: メディア再生のカスタム設定を指定します

説明

このパラメータは、メディア再生のカスタム設定を指定します。値はJSON文字列です。特定のストリーミングドメインの再生設定を構成できます。次の表に、PlayConfigのフィールドを示します。

項目	タイプ	必須	説明
PlayDomain	String	任意	ストリーミングドメイン。複数のオリジンドメイン名を設定する場合は、ビデオを再生するドメイン名を指定できます。指定されたストリーミングドメインが存在しない場合、ビデオのストレージアドレス用に設定されたデフォルトのストリーミングドメインがストリーミングURLで返されます。例: `"vod.test_domain"`
XForwardedFor	String	任意	リクエストを開始したクライアントの送信元IPアドレス。このフィールドは、レビューセキュリティグループに追加されたIPアドレスからリクエストが開始されたかどうかを確認するために使用されます。詳細については、「SetAuditSecurityIp」をご参照ください。 ApsaraVideo VODは、リクエストが複数のプロキシサーバーを通過した後、このフィールドに基づいてクライアントIPアドレスを取得できます。データのセキュリティを向上させるために、クライアントIPアドレスは`AES/ECB/PKCS5Padding`を使用して暗号化されます。暗号化キーを取得するには、チケットを起票して。例: yqCD7Fp1uqChoVj/sl/p5Q==。
PreviewTime	String	任意	プレビュー期間。単位は秒です。最小値は 1 です。最大値は、ビデオの合計期間です。このフィールドを空のままにすると、ビデオ全体がプレビューされます。プレビュー機能を有効にする方法の詳細については、「プレビュー機能の設定」をご参照ください。
MtsHlsUriToken	String	任意	トークン発行サービスによって生成されるMtsHlsUriToken。このフィールドを指定すると、HTTPライブストリーミング (HLS) 暗号化を使用して暗号化されたビデオを復号して再生できます。これにより、復号鍵の盗難が防止される。詳細については、「HLS暗号化」をご参照ください。
暗号化タイプ	String	任意	暗号化のタイプ。このフィールドを指定すると、暗号化されていないビデオや特定のタイプで暗号化されているビデオを再生できます。有効な値： Unencrypted: 暗号化されない AliyunVoDCryption: Alibaba Cloud独自の暗号化 HLSEncryption: HLS暗号化説明暗号化されたストリームの再生URLの詳細については、「再生URLの取得」をご参照ください。
StorageClass	String	任意	メディアアセットのストレージクラス。このフィールドを使用して、特定のストレージクラスの再生ストリームをフィルタリングできます。有効な値：デフォルトでは、このフィールドは空のままです。空の文字列は、フィルタリング条件を指定しません。オーディオファイルまたはビデオファイルのストレージクラスがStandardの場合、すべてのストリームの再生URLが返されます。メディアリソースのストレージクラスがStandardでない場合、再生URLは返されません。ソースファイルのストレージクラスがStandardでない場合、トランスコードされたストリームの再生URLのみが返され、元の品質のストリームの再生URLは返されません。すべて: すべてのストレージクラス。標準: すべてのメディアリソースは標準オブジェクトとして保存されます。 IA: すべてのメディアリソースはIAオブジェクトとして保存されます。アーカイブ: すべてのメディアリソースはアーカイブオブジェクトとして保存されます。 ColdArchive: すべてのメディアリソースは、Cold Archiveオブジェクトとして保存されます。 SourceIA: ソースファイルのみがIAオブジェクトです。 SourceArchive: ソースファイルのみがアーカイブオブジェクトです。 SourceColdArchive: ソースファイルのみがCold Archiveオブジェクトです。変更中: メディアリソースのストレージクラスが変更中です。 SourceChanging: ソースファイルのストレージクラスが変更中です。

サンプルコード

PlayConfig={
  "PlayDomain": "vod.test_domain",
  "XForwardedFor": "yqCD7Fp1uqChoVj/sl/p5Q==",
  "PreviewTime": "20",
  "MtsHlsUriToken": "yqCD7Fp1uqChoVjslp5Q",
  "StorageClass": "Standard"
}

ReAuthInfo: CDN再認証の設定を指定します。

説明

このフィールドは、メディア再生用のCDN再認証の設定を指定します。値はJSON文字列です。 CDN再認証機能を有効にした後、このフィールドを使用して、URL署名用のuidフィールドとrandフィールドを指定できます。次の表では、ReAuthInfoのフィールドについて説明します。

項目	タイプ	必須	説明
uid	String	任意	追加のフィールド。ほとんどの場合、値は0に設定されます。このフィールドにはカスタム値を指定できます。
rand	String	任意	乱数。ほとんどの場合、値は0に設定されます。ビデオが要求されるたびに異なるURLを生成するには、UUIDを乱数として使用します。

サンプルコード

ReAuthInfo={
  "uid": "12345",
  "rand": "abckljd"
}

UserData: メディアアップロードのカスタム設定を指定します。

説明

このフィールドには、イベント通知のコールバック設定など、メディアアップロードのカスタム設定を指定します。値はJSON文字列です。

次の表に、UserDataのフィールドを示します。

項目	タイプ	必須	説明
MessageCallback	String	任意	イベント通知のコールバック設定。値はJSONオブジェクトです。このフィールドを指定すると、指定されたコールバック設定が有効になります。それ以外の場合、デフォルトのコールバック設定が有効になります。詳細については、「複数のコールバックURLの指定」をご参照ください。次の内容は、パラメータについて説明します。 CallbackType: コールバックメソッド。有効な値: `http`および`mns`。 CallbackURL: HTTPコールバックURL。このパラメーターは、`CallbackType`を`http`に設定した場合に必要です。 MNSQueueName: メッセージサービス (MNS) キューの名前。このパラメーターは、`CallbackType`を`mns`に設定した場合に必要です。 MSSEndpoint: MNSキューのエンドポイント。このパラメーターは、`CallbackType`を`mns`に設定した場合に必要です。例： HTTPコールバック: `{"CallbackType":"http", "CallbackURL":"http:// callback-host/addr"}` MNSコールバック: `{"CallbackType":"mns","MNSQueueName":"vod-callback-bj","MNSSendpoint":"http:// 174809843091 **** .mns.cn-beijing.aliyuncs.com"}`
拡張	String	任意	カスタム拡張フィールド。イベントコールバック中に透過的に送信されます。値の長さは最大512バイトです。値はJSONオブジェクトです。説明ドル記号 ($) 、スラッシュ (/) 、バックスラッシュ (\) などの特殊文字を含む値をBase64-encoded文字列に変換することを推奨します。
AccelerateConfig	String	任意	アップロード高速化の設定。値はJSONオブジェクトです。例: {"Type":"oss","Domain":" https://oss-accelerate.aliyuncs.com "} 。 Typeはアクセラレーションメソッドを指定し、その値はossのみです。ドメインは、高速化ドメイン名を指定します。リージョンとエンドポイントから高速化ドメイン名を取得できます。デフォルトでは、HTTPSが使用されます。説明アップロード高速化機能は、アプリケーションを送信して機能を有効にした後にのみ使用できます。アップロードアクセラレーション機能を有効にする方法とその機能の課金ルールの詳細については、「アップロードアクセラレーション」をご参照ください。

サンプルコード

UserData={
  "MessageCallback": {
    "MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com",
    "MNSQueueName":"vod-callback-bj",
    "CallbackType": "mns"
  },
  "Extend": {
    "localId": "xxx",
    "test": "www"
  },
  "AccelerateConfig": {
    "Type": "oss",
    "Domain": "https://oss-accelerate.aliyuncs.com"
  }
}

EncryptConfig: HLS暗号化の設定を指定します。

このフィールドは、HLS暗号化の設定を指定します。

項目	タイプ	必須	説明
CipherText	String	必須	平文キーを取得するために使用される暗号文キー。 GenerateKMSDataKey操作への応答で、このパラメーターを`CiphertextBlob`の値に設定します。
DecryptKeyUri	String	必須	暗号文キーに基づいて取得されるキーURI。 URIは、復号化サービスのIPアドレスと`Ciphertext`の値で構成されます。設定した復号化サービス。たとえば、復号化サービスのIPアドレスが `http://demo.aliyundoc.com` の場合、このパラメーターを次の値に設定します。 `http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt ****`
KeyServiceType	String	必須	キーサービスのタイプ。デフォルト値: KMS。Alibaba CloudのKey Management Serviceを指定します。

SpriteSnapshotConfig: イメージスプライトをキャプチャするための設定を指定します

項目	タイプ	必須	説明
CellWidth	String	任意	イメージスプライトを構成する元のスナップショットの幅。デフォルト値: 通常のスナップショットの幅。単位: ピクセル。
CellHeight	String	任意	イメージスプライトを構成する元のスナップショットの高さ。デフォルト値: 通常のスナップショットの高さ。単位: ピクセル。
間隔	String	任意	イメージスプライトを構成する元のスナップショットのパディング。デフォルト値：0 単位: ピクセル。
マージン	String	任意	イメージスプライトを構成する元のスナップショットのマージン。デフォルト値：0 単位: ピクセル。
色	String	任意	イメージスプライトの背景色。デフォルト値: Black。
カラム	String	任意	イメージスプライトを構成する元のスナップショットの列数。有効な値: [1,10000] 。デフォルト値は 10 です。
Lines	String	任意	イメージスプライトを構成する元のスナップショットの行数。有効な値: [1,10000] 。デフォルト値は 10 です。
KeepCellPic	String	任意	イメージスプライトを構成する元のスナップショットを保持するかどうかを指定します。有効な値：キープ delete デフォルト値: keep

説明

SpriteSnapshotConfigのすべてのフィールドを対応するデフォルト値に設定する場合は、SpriteSnapshotConfigに空のJSON文字列を指定します。