批量配置域名。
接口说明
使用说明
先获取需要进行配置的直播域名,再调用本接口批量配置域名。
QPS 限制
本接口的单用户 QPS 限制为 30 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:BatchSetLiveDomainConfigs | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainNames | string | 是 | 需要进行批量配置的域名。取值可以是推流域名、主播流域名或子播流域名。多个域名用英文逗号(,)分隔。 | demo.aliyundoc.com,example.aliyundoc.com,example.com |
Functions | string | 是 | 功能列表。 某些功能,如 | [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}] |
Functions 格式说明
-
示例如下所示:
[{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]
-
某些功能,如 filetype_based_ttl_set,可以设置多条记录,当需要更新其中某条记录时,可通过该条记录的 configId 来指定,示例如下所示:
[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]
Functions 功能说明
名称 | 参数 |
---|---|
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 时间。单位:秒,取值范围是 1~99999999(3 年多一些)。 file_type:文件类型。多个使用英文逗号(,)隔开。 weight:权重。取值范围:1~99。 |
path_based_ttl_set:目录过期时间设置。 | ttl:cache 时间。单位:秒,取值范围是 1~99999999(3 年多一些)。 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 支持大写字母、小写字母、数字,建议设置长度为 8~32 个字符。 auth_key2:鉴权 key2。 ali_auth_delta:自定义鉴权缓冲时间,单位:分钟。建议最小设置为 1 分钟,无上限限制。 auth_m3u8:是否开启 m3u8 内容改写,对 m3u8 里面的 ts 补齐对应的鉴权,可以避免 ts 的访问鉴权失败。取值:on(默认值)或 off。 |
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:响应头。取值: Content-Type。 Cache-Control。 Content-Disposition。 Content-Language。 Expires。 Access-Control-Allow-Origin。 Access-Control-Allow-Methods。 Access-Control-Allow-Headers。 Access-Control-Max-Age。 Access-Control-Expose-Headers。 value:响应头内容。删除填写 null。 |
https_force:强制 HTTPS 跳转。 | enable:功能开关。取值:on 或 off。https_force 和 http_force 只能存在其中一个,两者为互斥关系,配置另外一个需要先删除原来的配置。 |
http_force:强制 HTTP 跳转。 | enable:功能开关。取值:on 或 off。https_force 和 http_force 只能存在其中一个,两者为互斥关系,配置另外一个需要先删除原来的配置。 |
forward_scheme:自适应回源。 | enable:功能开关,取值:on 或 off。 scheme_origin:回源站协议 (http、https、follow)。 scheme_origin_port:回源站协议端口(80、443、80:443)。 |
green_manager:鉴黄功能。 | enable:是否开启鉴黄功能。取值:on 或 off。 |
tmd_signature:自定义的访问频次控制规则。 | name:规则名称。域名内不可重复。 path:可重复,需校验 URI 路径合法性。 pathType:匹配规则。0 前缀匹配,1 完全匹配。 interval:监测时长。单位:秒。参数限制必须≥10。 count:单 IP 访问次数。 action:阻断类型。0 封禁,1 人机识别。 ttl:阻断时长。单位:秒。 |
l2_oss_key:L2 OSS 回源私钥。 | private_oss_auth:是否开启私有 OSS 鉴权功能。取值:on 或 off。 |
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。 |
cc_defense:防 CC 攻击。 | enable:开启或关闭防 CC 攻击。取值:on 或 off。 |
alilive:视频直播配置。 | notify_url:直播通知 URL。 enable:功能开关。取值:on 或 off。 live_forbid_flv:禁止播放 flv。取值:on 或 off。 live_forbid_rtmp:禁止播放 rtmp。取值:on 或 off。 live_forbid_hls:禁止播放 hls。取值:on 或 off。 |
ali_grtn:grtn 业务接入开关。 | grtn_rts_pub:RTS 推流开关,推流域名使用。取值:on 或 off。 grtn_rts_play:RTS 播流开关,播流域名使用。取值:on 或 off。 grtn_rts_transcode:RTS H5 播放自动转码开关。取值:on 或 off。 |
edge_function:边缘函数。 | 必填参数: rule:DSL 规则。 pri:优先级。 enable:本条规则是否生效。取值:on 或 off。 可选参数: name:规则名称。 pos:规则执行位置。 brk:命中本条规则后,当前执行位置剩余规则均跳过。 option:option 管控。 grammar:grammar 管控。可选值:空、es2、js。 jsmode:js 域名白单管控,可选值:redirect 或 bypass。 |
https_tls_version:TLS 协议版本。 | tls10:开启 TLSv1.0,默认为 on。取值:on 或 off。 tls11:开启 TLSv1.1,默认为 on。取值:on 或 off。 tls12:开启 TLSv1.2,默认为 on。取值:on 或 off。 tls13:开启 TLSv1.3,默认为 on。取值:on 或 off。 |
https_option:http 协议设置。 | http2:是否开启 http2,默认为 off。取值:on 或 off。 live_http2:是否开启 live_http2,默认为 off。取值:on 或 off。 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidFunctions.Malformed | Specified Functions is malformed. | - |
400 | InvalidFunctionArgs.Malformed | The specified FunctionArgs is invalid. | - |
400 | InvalidArgValue.Malformed | Specified ArgValue is malformed. | - |
400 | Invalid%s.ValueNotSupported | FunctionName [%s] is not supported. | - |
400 | Invalid%s.ValueNotSupported | ArgName [%s] is not supported. | - |
400 | Invalid%s.Malformed | ArgValue [%s] is malformed. | - |
400 | MissingParameter%s | The specified value of ArgName[%s] is missing. | - |
400 | FunctionMutex | Function is mutex with other function. | - |
400 | RewriteHostRely | Domain name is configured as rewrite host by others. | - |
400 | ConfigurationConflicts | The staging environment has a configuration in effect and cannot modify the production environment configuration. | 预发环境存在已生效配置,无法修改生产环境配置。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-29 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
错误代码 | 描述 | HTTP 状态码 | 语义 |
---|---|---|---|
InvalidFunctions.Malformed | Specified Functions is malformed. | 400 | 指定的 Functions 不合法。 |
InvalidFunctionName.ValueNotSupported | unctionName %s is not supported. | 400 | 不支持的 FunctionName %s(%s 为具体功能名)。 |
InvalidArgName.ValueNotSupported | ArgName %s is not supported. | 400 | 不支持的 ArgName %s(%s 为具体参数名)。 |
InvalidArgValue.Malformed | Specified ArgValue is malformed. | 400 | 指定的 ArgValue 不合法。 |