SetLiveEdgeTransferを呼び出して、ライブストリームリレー設定を構成します。
操作説明
SetLiveEdgeTransferを呼び出して行ったライブエッジストリームリレー構成は、構成完了後に開始されたストリームに対してのみ有効です。以下は、いくつかの典型的なシナリオの例です:
| シナリオ | 分析 | 結果 |
| 1. SetLiveEdgeTransferを呼び出す前に、ユーザーがすでにストリーミングを開始している。 | この時点ではライブエッジストリームリレー構成は存在しません。 | ストリームはSetLiveEdgeTransfer 構成の影響を受けず、ライブエッジストリームリレーは開始されません。 |
| 2. SetLiveEdgeTransferを呼び出す前に開始されたストリーミングをユーザーが中断し、その後ストリーミングを再開する。 | この時点ではライブエッジストリームリレー構成はすでに存在しています。 | 再開されたストリームは、SetLiveEdgeTransfer 構成に従ってライブストリームリレーを開始します。 |
| 3. SetLiveEdgeTransferを呼び出した後にユーザーがストリーミングを開始する。 | この時点ではライブエッジストリームリレー構成はすでに存在しています。 | このストリームは、SetLiveEdgeTransfer 構成に従ってライブストリームリレーを開始します。 |
QPS 制限
このAPIの単一ユーザーQPS 制限は1 秒あたり100 回です。制限を超えるとAPIスロットリングが発生し、ビジネスに影響を与える可能性があります。このAPIを適切に呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:SetLiveEdgeTransfer |
update |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョンID。 |
cn-shanghai |
| DomainName |
string |
必須 |
インジェストドメイン名。ライブストリームリレーはインジェストDomainNameの粒度で構成されます。各ドメインには1つのライブストリームリレー構成のみ設定できます。 |
demo.aliyundoc.com |
| AppName |
string |
任意 |
ライブストリームが属するアプリケーション名。例外付きの構成で正規表現がサポートされています。詳細については、以下のAppNameおよびStreamNameパラメータ構成手順を参照してください。例: liveApp****[1,2,3]は、liveApp1、liveApp2、liveApp****3の3つのアプリがストリームリレーを許可されていることを示します。 説明
|
liveApp**** |
| StreamName |
string |
任意 |
ストリーム名。例外付きの構成で正規表現がサポートされています。詳細については、以下のAppNameおよびStreamNameパラメータ構成手順を参照してください。例: liveStream****[1,2,3]は、liveStream1、liveStream2、liveStream****3の3つのストリームがストリームリレーを許可されていることを示します。 説明
|
liveStream**** |
| TargetDomainList |
string |
任意 |
ストリームリレー用にユーザーが指定したターゲットドメインのリスト。複数のドメインはカンマ(,)で区切ります。リクエストには 説明
|
learn.aliyundoc.com,guide.aliyundoc.com |
| HttpDns |
string |
任意 |
ストリームリレーのターゲットアドレスを取得するためのHTTPDNSインターフェース。リクエストには 説明
リクエストパラメータで ライブストリームリレーには、HTTPDNSインターフェースから返されるメッセージ構造に関する要件があります。詳細については、以下のHTTPDNS 説明を参照してください。 |
http://developer.aliyundoc.com |
| TransferArgs |
string |
任意 |
インジェストパラメータをパススルーするかどうかを指定します。有効な値:
列挙値:
|
yes |
AppNameおよびStreamNameパラメータ構成手順
AppNameもStreamNameも^または$のマッチングをサポートしていません。いずれかの値に^または$が含まれている場合、ストリームリレーは失敗します。
HTTPDNS 説明
SetLiveEdgeTransferのリクエストパラメータでHttpDnsが設定されている場合、ライブストリームリレーはHttpDnsを通じて設定されたHTTPDNSインターフェースにアクセスして、ストリームリレーのターゲットアドレスを取得します。
リクエスト例:
http://developer.aliyundoc.com/?host={
{
}: インジェストドメイン名。 {
}: ライブストリームが属するアプリケーション名。 {
}: ストリーム名。 {<_ali_user_args>}: ユーザーのインジェストストリームが持つパラメータ。
ライブストリームリレーのインターフェースリターンコードとリターンデータの要件は以下のとおりです:
リターンコード403はアクセス失敗を示し、ストリームリレーは不要です。
リターンコード200はアクセス成功を示し、結果はJSON 形式で返されます。構造とパラメータの例は以下のとおりです:
{
"cdn_types": [
{
"name": "cdnA****",
"upstream_url": "rtmp://developer.aliyundoc.com/live/testedge****"
},
{
"name": "cdnB****",
"upstream_url": "rtmp://developer.aliyundoc.com/live/testedge****"
}
]
}
| パラメータ | 説明 | 例 |
| name | CDN 名。カスタマイズ可能ですが、重複は許可されません。 | cdnA**** |
| upstream_url | リレー先のインジェストアドレス。 | rtmp://developer.aliyundoc.com/live/testedge**** |
リレードメインは返されたJSON 結果から取得されます。複数のリレードメインが返された場合、元のストリームを複数の宛先にプッシュする必要があることを意味します。
返されたデータ構造が要件を満たさない場合、ストリームリレーは失敗します。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CF8 |
例
成功レスポンス
JSONJSON
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParam | パラメーターが無効です。 | 不正な入力パラメーターです |
| 500 | InternalError | バックエンドサービスの例外により、リクエストの処理に失敗しました。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。