调用DescribeLiveDomainConfigs查询直播域名配置,一次可查询多个功能配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveDomainConfigs |
系统规定参数。取值:DescribeLiveDomainConfigs。 |
DomainName | String | 是 | live.yourdomain.com |
您的域名。 |
FunctionNames | String | 是 | set_req_host_header |
功能列表名称。多个功能使用英文逗号(,)分隔。更多详情,请参见下表Functions。 |
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时间。单位:秒。 file_type:文件类型。多个使用英文逗号(,)隔开。 weight:权重。取值范围:1~199。 |
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:TMD免拦截。 |
ip_list:IP列表。多个使用英文逗号(,)隔开。 |
error_page:错误页面重定向。 |
error_code:错误码。 rewrite_page:重定向页面。 |
set_req_host_header:修改回源Host头。 |
domain_name:回源Host头内容。 |
set_hashkey_args:忽略url参数。 |
hashkey_args:保留参数的列表。多个使用英文逗号(,)分隔。 disable:disable等于on的时候表示忽略所有参数,off不忽略。 |
aliauth:阿里鉴权。 |
auth_type:鉴权类型。取值:no_auth,type_a。 auth_key1:鉴权key1。 auth_key2:鉴权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 回源私钥。 |
private_oss_auth:是否开启私有OSS鉴权功能。取值:on或off。 |
green_manager:鉴黄功能。 |
enable:是否开启鉴黄功能。取值:on或off。 |
tmd_signature:TMD自定义规则。 |
name:规则名称。域名内不可重复。 path:可重复,需校验uri路径合法性。 pathType:匹配规则。0前缀匹配,1完全匹配。 interval:监测时长。单位:秒。参数限制必须≥10。 count:单IP访问次数。 action:阻断类型。0封禁,1人机识别。 ttl:阻断时长。单位:秒。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainConfigs | Array of DomainConfig |
直播域名配置。 |
|
DomainConfig | |||
ConfigId | String | 5003576 |
配置ID。 |
FunctionArgs | Array of FunctionArg |
域名功能配置参数。 |
|
FunctionArg | |||
ArgName | String | domain_name |
参数名称。 |
ArgValue | String | testscdn3.cdnpe.com |
参数值。 |
FunctionName | String | set_req_host_header |
域名配置功能名称。 |
Status | String | success |
配置状态。
|
RequestId | String | F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED |
请求ID。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainConfigs
&DomainName=live.yourdomain.com
&FunctionNames=set_req_host_header
&<公共请求参数>
正常返回示例
XML
格式
<DescribeLiveDomainConfigsResponse>
<RequestId>F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED</RequestId>
<DomainConfigs>
<DomainConfig>
<Status>success</Status>
<FunctionArgs>
<FunctionArg>
<ArgName>domain_name</ArgName>
<ArgValue>testscdn3.cdnpe.com</ArgValue>
</FunctionArg>
</FunctionArgs>
<ConfigId>5003576</ConfigId>
<FunctionName>set_req_host_header</FunctionName>
</DomainConfig>
<DomainConfig>
<FunctionArgs>
<Status>success</Status>
<FunctionArg>
<ArgName>file_type</ArgName>
<ArgValue>txt</ArgValue>
</FunctionArg>
<FunctionArg>
<ArgName>ttl</ArgName>
<ArgValue>13</ArgValue>
</FunctionArg>
<FunctionArg>
<ArgName>weight</ArgName>
<ArgValue>8</ArgValue>
</FunctionArg>
</FunctionArgs>
<ConfigId>5068995</ConfigId>
<FunctionName>filetype_based_ttl_set</FunctionName>
</DomainConfig>
</DomainConfigs>
</DescribeLiveDomainConfigsResponse>
JSON
格式
{
"RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
"DomainConfigs": {
"DomainConfig": [
{
"Status": "success",
"FunctionArgs": {
"FunctionArg": [
{
"ArgName": "domain_name",
"ArgValue": "testscdn3.cdnpe.com"
}
]
},
"ConfigId": 5003576,
"FunctionName": "set_req_host_header"
},
{
"FunctionArgs": {
"Status": "success",
"FunctionArg": [
{
"ArgName": "file_type",
"ArgValue": "txt"
},
{
"ArgName": "ttl",
"ArgValue": "13"
},
{
"ArgName": "weight",
"ArgValue": "8"
}
]
},
"ConfigId": 5068995,
"FunctionName": "filetype_based_ttl_set"
}
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交