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

ドメイン名の1つ以上の設定を照会します。

使用状況ノート

一度に複数の設定をクエリできます。

QPS limit

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

デバッグ

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

リクエストパラメーター

パラメーター	データ型	必須／任意	例	説明
操作	String	必須	DescribeLiveDomainConfigs	実行する操作です。値をDescribeLiveDomainConfigsに設定します。
DomainName	String	必須	demo.aliyundoc.com	取り込みドメイン名またはストリーミングドメイン名。
FunctionNames	String	必須	set_req_host_header,set_hashkey_args	機能の名前。複数のフィーチャはコンマ (,) で区切ります。詳細については、「機能」をご参照ください。

機能

機能	説明
referer_white_list_set: リファラーホワイトリストを指定します。	refer_domain_allow_list: the referers to be added to the whitelist. 複数のリファラーはコンマ (,) で区切ります。 allow_empty: 空のリファラーを許可するかどうかを指定します。有効な値: onとoff。
referer_black_list_set: specifies the referer blacklist.	refer_domain_deny_list: the referers to be added to the blacklist. Separate multiple referers with commas (,). allow_empty: 空のリファラーを許可するかどうかを指定します。有効な値: onとoff。
filetype_based_ttl_set: ファイルの有効期限を指定します。	ttl: キャッシュ期間。 (単位：秒) file_type: ファイルタイプ。複数のファイルタイプはコンマ (,) で区切ります。 weight: キャッシュ内のファイルの重み。有効な値: 1 ~ 199
path_based_ttl_set: ディレクトリの有効期限を指定します。	ttl: キャッシュ期間。 (単位：秒) path: the directory, which must start with a forward slash (/). weight: キャッシュ内のディレクトリの重み。有効値: 1 ~ 99
oss_auth: Object Storage Service (oss) バケットへのアクセスのための認証を設定します。	oss_bucket_id: OSSバケットの名前。
ip_black_list_set: IPアドレスブラックリストを指定します。	ip_list: ブラックリストに追加するipアドレス。 IP アドレスが複数ある場合はカンマ (,) で区切ります。
ip_allow_list_set: specifies the IP address whitelist.	ip_list: the IP addresses to be added to the whitelist. IP アドレスが複数ある場合はカンマ (,) で区切ります。
ip_white_list_set: specifies the IP address whitelist for rate limiting.	ip_list: the IP addresses to be added to the whitelist. IP アドレスが複数ある場合はカンマ (,) で区切ります。
error_page: エラーページを指定したページにリダイレクトします。	error_code: the error code. rewrite_page: エラーページのリダイレクト先のページ。
set_req_host_header: modifies the host header of back-to-origin requests.	domain_name: back-to-originリクエストのホストヘッダー。
set_hashkey_args: ignores the specified URL parameters.	hashkey_args: the parameters to be reserved. 複数のパラメーターはコンマ (,) で区切ります。 disable: すべてのパラメーターを無視するかどうかを指定します。 onの値は、すべてのパラメーターが無視されることを示します。 offの値は、パラメータのどれも無視されないことを示す。
aliauth: Alibaba Cloud認証を設定します。	auth_type: 認証タイプ。有効な値: type_aおよびno_auth。 type_aの値は、認証タイプAが有効であることを示します。 no_authの値は、認証が無効であることを示します。 auth_key1: プライマリ認証キー。認証キーの長さは16 ~ 32文字で、大文字、小文字、および数字を使用できます。 auth_key2: セカンダリ認証キー。 ali_auth_delta: 認証のカスタムバッファ時間。
set_resp_header: レスポンスヘッダーを設定します。設定を確認するには、応答メッセージをブラウザで確認します。	key: レスポンスヘッダーの名前。 value: レスポンスヘッダーの内容。ヘッダーを削除する場合は、nullを入力します。
https_force: httpsへの強制リダイレクトを設定します。	enable: この機能を有効にするかどうかを指定します。有効な値: onとoff。
http_force: httpへの強制リダイレクトを設定します。	enable: この機能を有効にするかどうかを指定します。有効な値: onとoff。
l2_oss_key: L2ノードからプライベートOSSバケットへのback-to-originリクエストの秘密鍵認証を設定します。	private_oss_auth: プライベートOSSバケットへのアクセスを認証するかどうかを指定します。有効な値: onとoff。
green_manager: ポルノ検出を設定します。	enable: ポルノ検出を有効にするかどうかを指定します。有効な値: onとoff。
tmd_signature: カスタムレート制限ルールを設定します。	name: ルールの名前。グローバルに一意である必要があります。 path: URI (uniform resource identifier) 。重複するURIを指定できます。ただし、それらの有効性を確認する必要があります。 pathType: 一致するルール。有効な値: 0と1。 0の値は、プレフィックスの一致を示します。値1は完全一致を示します。 interval: データが監視される間隔。 (単位：秒) 間隔は10秒以上でなければなりません。 count: IPアドレスからの訪問数。 action: 指定された条件が満たされた後に実行される操作。有効な値: 0と1。値0は、アクセスがブロックされていることを示します。値1は、ボット検出が実行されることを示す。 ttl: アクセスがブロックされている期間。 (単位：秒)
forward_scheme: アダプティブback-to-originを設定します。	enable: この機能を有効にするかどうかを指定します。有効な値: onとoff。 scheme_origin: オリジンのプロトコル。有効な値: http、https、およびfollow。 scheme_origin_port: オリジンのポート番号。有効な値: 80、443、および80:443。
range: オブジェクトのチャンクを設定します。	enable: この機能を有効にするかどうかを指定します。有効な値: onとoff。
video_seek: ビデオシークを設定します。	enable: この機能を有効にするかどうかを指定します。有効な値: onとoff。
gzip: Gzip圧縮を設定します。	enable: この機能を有効にするかどうかを指定します。有効な値: onとoff。
tesla: ページの最適化を設定してアクセスを高速化します。	enable: この機能を有効にするかどうかを指定します。有効な値: onとoff。
ali_ua: User-Agentベースのアクセス制御を設定します。	ua: ユーザーエージェント。 type: User-Agentリストのタイプ。有効な値: 黒と白。
host_redirect: URLの書き換えを設定します。	regex: 書き直されるURL (例: ^/$) 。 replacement: 最終的なURL (例: /go/act/sale/tbzlsy.php) 。 flag: アクション。有効な値: redirect and break。
ipv6: ipv6を設定します。	switch: 必須です。この機能を有効にした後にこの機能を無効にする場合は、設定を削除しないでください。それ以外の場合、機能は引き続き有効になります。有効な値: onとoff。 region: IPv6を有効にするリージョン。アスタリスク (*) を入力して、すべてのリージョンを指定できます。
ali_location: リージョンベースのアクセス制御を設定します。	location: リージョン。
type: リストのタイプを設定します。	有効な値: 黒と白。
enable: 上記の機能を有効にするかどうかを指定します。	有効な値: onとoff。
live_forbid_flv: FLVビデオの再生を禁止するかどうかを指定します。	有効な値: onとoff。
live_forbid_rtmp: Real-Time Messaging Protocol (RTMP) ビデオの再生を禁止するかどうかを指定します。	有効な値: onとoff。
live_forbid_hls: HTTPライブストリーミング (HLS) ビデオの再生を禁止するかどうかを指定します。	有効な値: onとoff。

説明すべてのパラメーター値は文字列型です。 filetype_based_ttl_setなどの一部の機能は、複数の構成レコードをサポートしています。いずれかの設定レコードを更新するには、configIdフィールドを使用してレコードを指定します。

レスポンスパラメーター

パラメーター	データ型	例	説明
DomainConfigs	DomainConfigの配列		照会されたドメイン名の設定。
DomainConfig
ConfigId	String	5003576	設定のID。
FunctionArgs	FunctionArgの配列		設定のパラメーター。
FunctionArg
ArgName	String	domain_name	設定パラメーターの名前。
ArgValue	String	developer.aliyundoc.com	パラメーターの値です。
FunctionName	String	set_req_host_header	フィーチャーの名前。
ステータス	String	success	設定ステータス。設定可能な値は以下のとおりです。成功テスト失敗しました設定
RequestId	String	F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED	リクエストの ID です。

例

リクエストの例

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

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

XML 形式

<DescribeLiveDomainConfigsResponse>
  <RequestId>F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED</RequestId>
  <DomainConfigs>
        <DomainConfig>
              <ステータス> 成功 </ステータス>
              <FunctionName>set_req_host_header</FunctionName>
              <ConfigId>5003576</ConfigId>
              <FunctionArgs>
                    <FunctionArg>
                          <ArgValu e>developer.aliyundoc.com</ArgValue>
                          <ArgName>domain_name</ArgName>
                    </FunctionArg>
              </FunctionArgs>
        </DomainConfig>
  </DomainConfigs>
</DescribeLiveDomainConfigsResponse>

JSON 形式

{
    "DescribeLiveDomainConfigsResponse": {
        "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED" 、
        "DomainConfigs": {
            "DomainConfig": {
                "ステータス": "成功" 、
                "FunctionName": "set_req_host_header" 、
                "ConfigId": 5003576、
                "FunctionArgs": {
                    "FunctionArg": {
                        "ArgValue": "developer.aliyundoc.com" 、
                        "ArgName": "domain_name"
                    }
                }
            }
        }
    }
}

エラーコード

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