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

使用状況ノート

設定は、設定を設定した後にプッシュされるストリームにのみ適用されます。以下は、いくつかの典型的なシナリオです。


シナリオ	推論	結果
ユーザーは、このAPIを使用して設定を設定する前にストリームをプッシュしました。	プッシュされるストリームの設定は存在しません。	設定は、プッシュされるストリームには適用されません。
ユーザーは、このAPIを使用して設定を設定する前にストリームをプッシュしました。設定後、ユーザーはストリームのプッシュをしばらく停止し、プッシュを再開します。	設定は、ストリームプッシュが再開された後に存在します。	設定は、再度プッシュされるストリームに適用されます。
ユーザーは、このAPIを使用して設定を設定した後にスチームをプッシュします。	プッシュされるストリームの設定が存在します。	設定は、プッシュされるストリームに適用されます。

QPS制限

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

デバッグ

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

リクエストパラメーター


パラメーター	データ型	必須／任意	例	説明
操作	String	必須	SetLiveEdgeTransfer	実行する操作です。値をSetLiveEdgeTransferに設定します。
DomainName	String	必須	demo.aliyundoc.com	The ingest domain.
RegionId	String	任意	cn-shanghai	取り込みドメインが存在するリージョンのID。
AppName	String	任意	liveApp ****	プッシュされる1つ以上のライブストリームが属するアプリケーションの名前。このパラメーターは、TargetDomainListパラメーターが設定されている場合にのみ有効です。正規表現を指定できます。たとえば、test[1,2、3] は、設定がtest1、test2、およびtest3という名前のアプリケーションのストリームに適用可能であることを示します。重要正規表現に ^ または $を含めないでください。それ以外の場合、設定を使用してストリームを転送できません。
StreamName	String	任意	liveStream****	プッシュする取り込みストリームの名前。このパラメーターは、TargetDomainListパラメーターが設定されている場合にのみ有効です。正規表現を指定できます。たとえば、streamtest[1,2,3] は、設定がstreamtest1、streamtest2、およびstreamtest3という名前のストリームに適用可能であることを示します。重要 Do not include ^ or $ in the regular expression. それ以外の場合、設定を使用してストリームを転送できません。
TargetDomainList	String	任意	learn.aliyundoc.com,guide.aliyundoc.com	取り込まれたストリームをプッシュする宛先ドメイン名。複数のドメイン名はコンマ (,) で区切ります。注 HttpDnsパラメーターとTargetDomainListパラメーターのどちらか一方のみを指定します。
HttpDns	String	任意	http://developer.aliyundoc.com	宛先ドメイン名を取得するために使用されるHTTPDNSインターフェイス。 For more information, see the HTTPDNS section in this topic. 注 HttpDnsパラメーターとTargetDomainListパラメーターのいずれかのみを指定します。 HttpDnsを指定した場合、AppNameおよびStreamNameパラメーターは有効になりません。
TransferArgs	String	任意	必須	取り込みストリームに関連するパラメーターのパススルーを有効にするかどうかを指定します。設定可能な値は以下のとおりです。 yes: パススルーを有効にします。 no: disables pass-through.

HTTPDNS

HTTPDNSパラメーターで指定されたHttpDnsインターフェイスは、ライブストリーム転送の宛先ドメイン名を取得するために使用されます。次に、HTTPDNSインターフェイスへのリクエストの例を示します。

http://developer.aliyundoc.com/?host={<host >}& app ={< app }>& name ={< name >}{<_ ali_user_args>}

リクエスト内の変数は、取り込まれたストリームのURL内の情報に置き換えられます。

{<host>}: the ingest domain.
{<app >}&: ストリームが属するアプリケーションの名前。
{<name >}: ストリームの名前。
{<_ 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) ノードの名前。一意の名前をカスタマイズできます。
upstream_url: 取り込んだストリームをプッシュする宛先ドメイン名。

注

複数の宛先ドメイン名が返された場合、取り込まれたストリームは複数のドメイン名にプッシュされます。
返された結果が要件を満たさない場合、ライブ転送は失敗する可能性があります。

レスポンスパラメーター


パラメーター	データ型	例	説明
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CF8	リクエストの ID です。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=SetLiveEdgeTransfer
&DomainNam e=demo.aliyundoc.com
&<共通リクエストパラメーター>

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

XML 形式

<SetLiveEdgeTransferResponse>
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>
</SetLiveEdgeTransferResponse>

JSON 形式

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

エラーコード

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