DescribeStreamLocationBlock - ApsaraVideo Live - Alibaba Cloud ドキュメントセンター

ストリームレベルのリージョンブロッキングの設定を照会します。

使用上の注意

ストリーミングドメインを取得し、この操作を呼び出して、ストリームレベルのリージョンブロックの設定を照会します。

QPS制限

この操作は、アカウントごとに1秒あたり最大50回呼び出すことができます。この制限を超えるリクエストは削除され、サービスが中断されます。この操作を呼び出す際は、この制限にご注意ください。詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

リクエストパラメーター

パラメーター	データ型	必須	説明
Action	String	課金されます	実行する操作です。値をDescribeStreamLocationBlockに設定します。
DomainName	String	課金されます	ストリーミングドメイン。
AppName	String	課金されません	ライブストリームが属するアプリケーションの名前。
StreamName	String	課金されません	ライブストリームの名前。
BlockType	String	課金されません	ブロッキングタイプ。有効な値: blacklistおよびwhitelist。
PageNum	Integer	課金されません	ページ番号。デフォルト値は 1 です。
PageSize	Integer	課金されません	1 ページあたりのエントリー数。有効値: 1から100までの整数。

レスポンスパラメーター

パラメーター	データ型	説明
RequestId	String	リクエスト ID。
集計	Integer	指定された条件を満たすストリームレベルのリージョンブロック設定の総数。
PageNum	Integer	ページ番号。
PageSize	Integer	1 ページあたりのエントリー数。
TotalPage	Integer	返されたページの総数。
StreamBlockList	StreamBlock[]	詳細。
DomainName	String	高速化ドメイン名。
AppName	String	ブロックが適用されるアプリケーションの名前。
StreamName	String	ストリームの名前。
BlockType	String	ブロッキングタイプ。有効な値: blacklistおよびwhitelist。
LocationList	String	ブロックされたリージョン。 CNやasなど、複数のリージョンが指定されている場合、それらはコンマ (,) で区切られます。
Status	Integer	ブロッキングステータス。有効な値: 0 (開始されていない) 、1 (ブロッキング) 、2 (成功) 、3 (失敗) 、4 (期限切れ) 、および5 (削除) 。
ReleaseTime	String	ブロッキングが終了する時間。日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。時刻は UTC で表示されます。
updateTime	String	設定が最後に変更された時刻。日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。時刻は UTC で表示されます。

特殊エラーコード

エラーコード	エラーメッセージ	HTTPステータスコード	説明
内部エラー	不明なエラーにより、リクエスト処理が失敗しました。	500	不明なエラーが発生した場合に返されるエラーメッセージ。
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	Alibaba Cloudアカウント内にドメイン名が見つからない場合に返されるエラーメッセージ。
InvalidParam	パラメーターが無効です。	400	1つ以上のパラメーターが無効な場合に返されるエラーメッセージ。

例

リクエストの例

https://live.aliyuncs.com?Action=DescribeStreamLocationBlock&DomainName=example.com&<Common request parameters>

レスポンスの例

{
    "RequestId": "0D70427D-91E4-4349-AAD3-5511A5BB823B",
    "Count": 2,
    "StreamBlockList": {
        "StreamBlock": [
            {
                "DomainName": "example.com",
                "AppName": "test",
                "StreamName": "test",
                "BlockType": "whitelist",
                "LocationList": "CN,AS",
                "Status": 2,
                "ReleaseTime": "2023-03-14T03:02:48Z"
            },
            {
                "DomainName": "example.com",
                "AppName": "test",
                "StreamName": "test1",
                "BlockType": "whitelist",
                "LocationList": "CN,AS",
                "Status": 2,
                "ReleaseTime": "2023-03-14T03:02:48Z"
            }
        ]
	}
}