全部产品
Search

搜索本产品

    视频直播：DescribeLiveDomainConfigs - 查询直播域名配置

    文档中心

    视频直播：DescribeLiveDomainConfigs - 查询直播域名配置

    更新时间：Nov 14, 2024

    查询直播域名配置，一次可查询多个功能配置。

    接口说明

    此接口一次可查询多个功能配置。

    QPS 限制

    本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    live:DescribeLiveDomainConfigsget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    DomainNamestring是

    您的推流域名或播流域名。

    		demo.aliyundoc.com
    FunctionNamesstring是

    功能列表名称。多个功能使用英文逗号（,）分隔。更多详情，请参见下表Functions 功能说明。

    		set_req_host_header,set_hashkey_args

    Functions 功能说明

    说明 所有参数值均按照字符串类型处理。 某些功能，例如：filetype_based_ttl_set，可以设置多条纪录。当需要更新其中某条纪录时，可通过该条纪录的 configId 来指定。
    名称参数
    referer_white_list_set：refer 白名单。refer_domain_allow_list：白名单列表，多个使用英文逗号（,）分隔。
    allow_empty：是否允许空 refer 进入。取值：on 或 off。
    referer_black_list_set：refer 黑名单。refer_domain_deny_list：黑名单列表，多个使用英文逗号（,）分隔。
    allow_empty：是否允许空 refer 进入。取值：on 或 off。
    filetype_based_ttl_set：文件过期时间设置。ttl：cache 时间。单位：秒。
    file_type：文件类型。多个使用英文逗号（,）隔开。
    weight：权重。取值范围：1~99。
    path_based_ttl_set：目录过期时间设置。ttl：cache 时间。单位：秒。
    path：目录。必须以正斜线（/）开头。
    weight：权重。取值范围：1~99。
    oss_auth：OSS 鉴权 Bucket。oss_bucket_id：用户 bucket 名称。
    ip_black_list_set：IP 黑名单。ip_list：IP 列表。多个使用英文逗号（,）隔开。
    ip_allow_list_set：IP 白名单。ip_list：IP 列表。多个使用英文逗号（,）隔开。
    ip_white_list_set：访问频次控制免拦截。ip_list：IP 列表。多个使用英文逗号（,）隔开。
    error_page：错误页面重定向。error_code：错误码。
    rewrite_page：重定向页面。
    set_req_host_header：修改回源 Host 头。domain_name：回源 Host 头内容。
    set_hashkey_args：忽略 url 参数。hashkey_args：保留参数的列表。多个使用英文逗号（,）分隔。
    disable：是否忽略所有参数。取值：仅支持 on（忽略所有参数）或 off（不忽略）。
    aliauth：阿里鉴权。auth_type：鉴权类型。取值：type_a（鉴权 A）、no_auth（关闭鉴权）。
    auth_key1：鉴权 key1，鉴权 key 需为 16~32 个字符，支持大写字母、小写字母、数字。
    auth_key2：鉴权 key2。
    ali_auth_delta：自定义鉴权缓冲时间，单位：秒。建议最小设置为 60 秒，无上限限制。
    remote_auth：直播远程鉴权 。enable：是否开启远程鉴权，必填项。取值：on 或 off。
    remote_auth_path ： 鉴权服务器地址，必填项。
    remote_auth_pattern ：鉴权模式串。有以下功能可设置：
    - param：是否向鉴权服务器透传推流 URL 中的参数，取值 pass（默认）或 fail。
    - args_white：透传指定参数设置，多个参数用英文逗号（,）分隔。
    - args_black：不透传指定参数设置，多个参数用英文逗号（,）分隔。
    - code：鉴权状态码，code=XXX，鉴权服务器在鉴权成功时返回给直播的 HTTP 状态码。例如：code=200。code=~XXX，鉴权服务器在鉴权失败时返回给直播的 HTTP 状态码。例如：code=~403。
    - delta ：鉴权超时时长。
    - retry：鉴权超时重试次数。
    - timeout：鉴权超时行为，取值：pass 或 fail。pass：视频直播将直接通过用户请求。fail：视频直播将响应鉴权失败状态码（403）给用户。
    - async：异步鉴权，取值 on（开启异步鉴权）或 off（默认，关闭异步鉴权）。
    set_resp_header：设置响应头（浏览器端可见）。key：响应头。
    value：响应头内容。删除填写 null。
    https_force：强制 HTTPS 跳转。enable：功能开关。取值：on 或 off。https_force 和 http_force 只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。
    http_force：强制 HTTP 跳转。enable：功能开关。取值：on 或 off。https_force 和 http_force 只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。
    l2_oss_key：L2 OSS 回源私钥。private_oss_auth：是否开启私有 OSS 鉴权功能。取值：on 或 off。
    green_manager：鉴黄功能。enable：是否开启鉴黄功能。取值：on 或 off。
    tmd_signature：自定义的访问频次控制规则。name：规则名称。域名内不可重复。
    path：可重复，需校验 uri 路径合法性。
    pathType：匹配规则。0 前缀匹配，1 完全匹配。
    interval：监测时长。单位：秒。参数限制必须≥10。
    count：单 IP 访问次数。
    action：阻断类型。0 封禁，1 人机识别。
    ttl：阻断时长。单位：秒。
    forward_scheme：自适应回源。enable：功能开关，取值：on 或 off。
    scheme_origin：回源站协议（http、https、follow）。
    scheme_origin_port：回源站协议端口（80、443、80:443）。
    video_seek：视频切片拖拽开关。enable：功能开关，取值：on 或 off。
    gzip：页面 Gzip 优化。enable：功能开关，取值：on 或 off。
    tesla：页面优化加速。enable：功能开关，取值：on 或 off。
    ali_ua：User-Agent 限制访问。ua：User-Agent
    type：取值类型（black、white）。
    host_redirect：rewrite 功能。regex：需要重写的 URL，例如 ^/$。
    replacement：目标 URL，例如 /go/act/sale/tbzlsy.php。
    flag：仅支持：redirect、break。
    ipv6：ipv6 配置。switch：必填，开关，支持 on 或 off，开启功能，一旦开启后，如需关闭请取消勾选，不要删除配置，否则不生效。
    region：开启 IPv6 功能的地区，取值：cn-beijing（北京）、cn-shanghai（上海）、cn-shenzhen（深圳）、cn-qingdao（青岛）、apsoutheast-1（新加坡）、eu-central-1（德国）、ap-northeast-1（东京）、ap-southeast-5（雅加达）。
    ali_location：区域限制访问。location：地域列表。
    type：取值类型。black、white。
    enable：功能开关。取值：on 或 off。
    live_forbid_flv：禁止播放 flv。取值：on 或 off。
    live_forbid_rtmp：禁止播放 rtmp。取值：on 或 off。
    live_forbid_hls：禁止播放 hls。取值：on 或 off。
    https_option：http 协议设置。http2：是否开启 http2，默认为 off。取值：on 或 off。
    live_http2：是否开启 live_http2，默认为 off。取值：on 或 off。

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED
    DomainConfigsarray<object>

    直播域名配置。

    DomainConfigobject
    Statusstring

    配置状态，取值：

    • success：配置成功。
    • testing：测试中。
    • failed：配置失败。
    • configuring：配置中。
    		success
    ConfigIdstring

    配置 ID。

    		5003576
    FunctionNamestring

    域名配置功能名称。

    		set_req_host_header
    FunctionArgsarray<object>

    域名功能配置参数。

    FunctionArgobject
    ArgNamestring

    参数名称。

    		domain_name
    ArgValuestring

    参数值。

    		developer.aliyundoc.com

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ConfigId": "5003576",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "domain_name",
              "ArgValue": "developer.aliyundoc.com"
            }
          ]
        }
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息
    400Invalid%s.ValueNotSupportedFunctionName [%s] is not supported.
    404InvalidUserThe user's account is invalid.

    访问错误中心查看更多错误码。