调用DescribeDomainConfigs获取指定加速域名的配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDomainConfigs |
系统规定参数。取值:DescribeDomainConfigs。 |
DomainName | String | 是 | test.test.com |
加速域名,仅支持单个查询。 |
ConfigList | String | 否 | cache_expired |
需要查询的配置,多个使用英文逗号(,)分隔。 默认查询所有。 |
ConfigList说明。
名称 |
类型 |
描述 |
---|---|---|
cache_expired |
String |
目录或文件过期配置。 |
cc |
String |
CC防护功能、IP黑白名单配置。 |
error_page |
String |
自定义404错误页面跳转。 |
http_header |
String |
自定义http头。 |
optimize |
String |
页面优化。 |
page_compress |
String |
智能压缩。 |
ignore_query_string |
String |
过滤参数。 |
range |
String |
Range回源功能。 |
referer |
String |
Referer防盗链功能。 |
req_auth |
String |
访问鉴权配置。 |
src_host |
String |
回源host。 |
video_seek |
String |
拖拽播放功能。 |
waf |
String |
Waf防护功能。 |
notify_url |
String |
视频直播notify url。 |
redirect_type |
String |
强制访问跳转方式,取值:Off、 Http、Https。 |
dynamic |
String |
全站加速相关配置信息。 |
set_req_header |
String |
设置回源自定义头。 |
remove_query_string |
String |
忽略url参数(删除)。 |
l2_oss_key |
String |
L2 OSS回源私钥。 |
macservice |
String |
移动加速。 |
green_manager |
String |
图片鉴黄。 |
https_option |
String |
Https基础参数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 发送到发 |
请求ID。 |
DomainConfigs | Struct |
对应的配置数据。 |
|
AliBusinessConfig | Struct |
特定用户定制。 |
|
AliBusinessTable | String | abc |
模式字符串。 |
AliBusinessType | String | typea |
业务类型。 |
ConfigId | String | 4125638 |
配置id。 |
Status | String | success |
配置状态。 |
CacheExpiredConfigs | Array of CacheExpiredConfig |
文件、路径过期时间设置。 |
|
CacheExpiredConfig | |||
CacheContent | String | jpeg111111 |
文件类型/路径。 |
CacheType | String | suffix |
缓存类型。 |
ConfigId | String | 604991 |
配置id。 |
Status | String | success |
配置状态。 |
TTL | String | 1000 |
cache时间。 单位:秒。 |
Weight | String | 1 |
SeqId。 |
CcConfig | Struct |
防cc攻击。 |
|
AllowIps | String | 1.2.3.4 |
TMD免拦截。 |
BlockIps | String | 3.4.5.6 |
IP黑名单。 |
ConfigId | String | 123 |
配置id。 |
Enable | String | on |
开启或关闭防CC攻击。 |
Status | String | success |
配置状态。 |
DynamicConfigs | Array of DynamicConfig |
全站加速配置。 |
|
DynamicConfig | |||
ConfigId | String | 20 |
配置id。 |
DynamicCacheControl | String | no-cache |
Cache-Control内容匹配配置中任一规则强制开启动态加速,不再检查其余配置。 |
DynamicOrigin | String | http |
回源路由scheme。 |
Enable | String | on |
开关。 |
StaticPath | String | /to/no_dynamic_rou |
URI为和配置内容正则匹配正确时关闭动态加速,多个用空格隔开,完全匹配(^配置内容$),如果需要彻底关闭动态加速可用“/*”或“*”。 |
StaticType | String | jpg |
文件后缀名完全匹配配置内容时关闭动态加速,多个用空格隔开。 |
StaticUri | String | yyy/ggss/ccc/a.txt |
URI和配置内容完全匹配时关闭动态加速,多个用空格隔开。 |
Status | String | success |
配置状态。 |
ErrorPageConfig | Struct |
错误页面重定向。 |
|
ConfigId | String | 123 |
配置id。 |
CustomPageUrl | String | http://promotion.alicdn.com/help/oss/error.html |
重定向页面。 |
ErrorCode | String | 404 |
错误码。 |
PageType | String | charity |
类型。 |
Status | String | success |
配置状态。 |
ForwardSchemeConfig | Struct |
swift自适应回源。 |
|
ConfigId | String | 123 |
配置id。 |
Enable | String | on |
开关。 |
SchemeOrigin | String | http |
回源站协议 :http、https、follow 。 |
SchemeOriginPort | String | 80 |
回源站协议端口 (80|443|80:443) 。 |
Status | String | success1 |
配置状态。 |
GreenManagerConfig | Struct |
图片鉴黄。 |
|
ConfigId | String | 4047862 |
配置id。 |
Enabled | String | off |
开关。 |
Status | String | success |
配置状态。 |
HttpErrorPageConfigs | Array of HttpErrorPageConfig |
错误页面重定向。 |
|
HttpErrorPageConfig | |||
ConfigId | String | 23 |
配置id。 |
ErrorCode | String | 501 |
错误码。 |
PageUrl | String | http://test.com/501.html |
重定向页面。 |
Status | String | success |
配置状态。 |
HttpHeaderConfigs | Array of HttpHeaderConfig |
设置响应头(浏览器端可见)。 |
|
HttpHeaderConfig | |||
ConfigId | String | 602016 |
配置id。 |
HeaderKey | String | content-type |
应答头支持参数任何内容。 |
HeaderValue | String | application |
应答头内容支持参数任何内容,删除头请填写null。 |
Status | String | success |
配置状态。 |
HttpsOptionConfig | Struct |
HTTPS基础参数。 |
|
ConfigId | String | 3498758 |
配置id。 |
Http2 | String | off |
http2开关。 |
Status | String | success |
配置状态。 |
IgnoreQueryStringConfig | Struct |
忽略url参数(保留)。 |
|
ConfigId | String | 123 |
配置id。 |
Enable | String | on |
缓存hashkey忽略所有参数。 |
HashKeyArgs | String | time |
缓存hashkey保留的参数列表,多个用逗号(,)分隔,内容只允许是64位的10个元素。 |
Status | String | success |
配置状态。 |
IpAllowListConfig | Struct |
IP白名单。 |
|
ConfigId | String | 123 |
配置id。 |
IpAclXfwd | String | on |
on优先使用xff头中的ip,off优先使用remote_addr,all同时匹配。 |
IpList | String | 8.8.8.8 |
IP列表多个用逗号(,)隔开。 |
Status | String | success |
配置状态。 |
L2OssKeyConfig | Struct |
L2 OSS回源私钥。 |
|
ConfigId | String | 3512607 |
配置id。 |
PrivateOssAuth | String | on |
是否开启私有oss鉴权功能。 |
Status | String | success |
配置状态。 |
MacServiceConfig | Struct |
移动加速。 |
|
AppList | String | app,app2 |
applist。 |
ConfigId | String | 3605171 |
配置id。 |
Enabled | String | on |
开关。 |
ProcessResult | String | 0 |
|
Status | String | success |
配置状态。 |
NotifyUrlConfig | Struct |
直播。 |
|
Enable | String | on |
开关。 |
NotifyUrl | String | http://test.com |
url。 |
OptimizeConfig | Struct |
页面优化加速。 |
|
ConfigId | String | 123123 |
配置id。 |
Enable | String | off |
开关。 |
Status | String | success |
配置状态。 |
PageCompressConfig | Struct |
页面Gzip优化。 |
|
ConfigId | String | 123 |
配置id。 |
Enable | String | off |
开关。 |
Status | String | success |
配置状态。 |
RangeConfig | Struct |
Range请求功能。 |
|
ConfigId | String | 123 |
配置id。 |
Enable | String | on |
开关。 |
Status | String | success |
配置状态。 |
RedirectTypeConfig | Struct |
强制HTTP/HTTPS跳转。 |
|
RedirectType | String | Https |
强制跳转。 |
RefererConfig | Struct |
Referer黑白名单设置。 |
|
AllowEmpty | String | on |
允许空refer进入。 |
ConfigId | String | 123 |
配置id。 |
DisableAst | String | test |
关闭域名前的. ,使用精确匹配。 |
ReferList | String | www.aliyun.com |
refer域名,多个域名用逗号(,)隔开,前后不能包含“.”,后缀匹配。 |
ReferType | String | block |
refer类型。 |
Status | String | success |
配置状态。 |
RemoveQueryStringConfig | Struct |
忽略url参数(删除)。 |
|
AliRemoveArgs | String | time |
删除指定的参数,多个参数之间用空格隔开,剩余参数将作为hashkey中URL args部分。 |
ConfigId | String | 1123 |
配置id。 |
Status | String | success |
配置状态。 |
ReqAuthConfig | Struct |
阿里鉴权。 |
|
AliAuthWhiteList | String | test |
鉴权白名单。 |
AuthAddr | String | http://test.com/test |
远程验证服务器地址url。 |
AuthM3u8 | String | on |
开启m3u8内容改写功能:on|off。 |
AuthRemoteDesc | String | test |
模式字符串。 |
AuthType | String | type_c |
类型。 |
ConfigId | String | 123 |
配置id。 |
Key1 | String | vadfawerq |
鉴权keyA。 |
Key2 | String | Acbdert |
鉴权keyB。 |
Status | String | success |
配置状态。 |
TimeOut | String | 2400 |
自定义鉴权缓冲时间。 |
ReqHeaderConfigs | Array of ReqHeaderConfig |
修改回源自定义头。 |
|
ReqHeaderConfig | |||
ConfigId | String | 123 |
配置id。 |
Key | String | testKey |
回源头。 |
Status | String | success |
配置状态。 |
Value | String | testValue |
回源头内容,删除头请填写null。 |
SetVarsConfigs | Array of SetVarsConfig |
变量设置。 |
|
SetVarsConfig | |||
ConfigId | String | 4125719 |
配置id。 |
Status | String | success |
配置状态。 |
VarName | String | typeb |
已存在的nginx可写变量。 |
VarValue | String | typeb |
变量值,可引用其他变量。 |
SrcHostConfig | Struct |
修改回源Host头。 |
|
ConfigId | String | 123 |
配置id。 |
DomainName | String | www.aliyun.com |
回源Host头内容。 |
Status | String | success |
配置状态。 |
VideoSeekConfig | Struct |
视频切片拖拽开关。 |
|
ConfigId | String | 123 |
配置id。 |
Enable | String | on |
开关。 |
Status | String | success |
配置状态。 |
WafConfig | Struct |
防跨站注入攻击。 |
|
ConfigId | String | 123 |
配置id。 |
Enable | String | off |
开关。 |
Status | String | success |
配置状态。 |
示例
请求示例
http://cdn.aliyuncs.com?Action=DescribeDomainConfigs
&DomainName=example.com
&ConfigList="cache_expired,cc,page_compress"
&<公共请求参数>
正常返回示例
XML
格式
<name>name</name>
<Users>
<userName>a</userName>
</Users>
<Users>
<userName>b</userName>
</Users>
<Users>
<userName>c</userName>
</Users>
JSON
格式
{
"RequestId": "发送到发",
"DomainConfigs": {
"AliBusinessConfig": {
"AliBusinessTable": "abc",
"AliBusinessType": "typea",
"ConfigId": 4125638,
"Status": "success"
},
"CacheExpiredConfigs": {
"CacheExpiredConfig": [
{
"CacheContent": "jpeg111111",
"CacheType": "suffix",
"ConfigId": 604991,
"Status": "success",
"TTL": 1000
}
]
},
"CcConfig": {
"AllowIps": "1.2.3.4",
"BlockIps": "3.4.5.6",
"ConfigId": 123,
"Enable": "on",
"Status": "success"
},
"DynamicConfigs": {
"DynamicConfig": [
{
"ConfigId": 20,
"DynamicCacheControl": "no-cache",
"DynamicOrigin": "http",
"Enable": "on",
"StaticPath": "/to/no_dynamic_rou",
"StaticType": "jpg",
"StaticUri": "yyy/ggss/ccc/a.txt",
"Status": "success"
}
]
},
"ErrorPageConfig": {
"ConfigId": 123,
"CustomPageUrl": "http://promotion.alicdn.com/help/oss/error.html",
"ErrorCode": 404,
"PageType": "charity",
"Status": "success"
},
"ForwardSchemeConfig": {
"ConfigId": 123,
"Enable": "on",
"SchemeOrigin": "http",
"SchemeOriginPort": 80,
"Status": "success1"
},
"GreenManagerConfig": {
"ConfigId": 4047862,
"Enabled": "off",
"Status": "success"
},
"HttpErrorPageConfigs": {
"HttpErrorPageConfig": [
{
"ConfigId": 23,
"ErrorCode": 501,
"PageUrl": "http://test.com/501.html",
"Status": "success"
}
]
},
"HttpHeaderConfigs": {
"HttpHeaderConfig": [
{
"ConfigId": 602016,
"HeaderKey": "content-type",
"HeaderValue": "application",
"Status": "success"
}
]
},
"HttpsOptionConfig": {
"ConfigId": 3498758,
"Http2": "off",
"Status": "success"
},
"IgnoreQueryStringConfig": {
"ConfigId": 123,
"Enable": "on",
"HashKeyArgs": "time",
"Status": "success"
},
"IpAllowListConfig": {
"ConfigId": 123,
"IpAclXfwd": "on",
"IpList": "8.8.8.8",
"Status": "success"
},
"L2OssKeyConfig": {
"ConfigId": 3512607,
"PrivateOssAuth": "on",
"Status": "success"
},
"MacServiceConfig": {
"AppList": "app,app2",
"ConfigId": 3605171,
"Enabled": "on",
"ProcessResult": 0,
"Status": "success"
},
"NotifyUrlConfig": {
"Enable": "on",
"NotifyUrl": "http://test.com"
},
"OptimizeConfig": {
"ConfigId": 123123,
"Enable": "off",
"Status": "success"
},
"PageCompressConfig": {
"ConfigId": 123,
"Enable": "off",
"Status": "success"
},
"RangeConfig": {
"ConfigId": 123,
"Enable": "on",
"Status": "success"
},
"RedirectTypeConfig": {
"RedirectType": "Https"
},
"RefererConfig": {
"AllowEmpty": "on",
"ConfigId": 123,
"DisableAst": "test",
"ReferList": "www.aliyun.com",
"ReferType": "block",
"Status": "success"
},
"RemoveQueryStringConfig": {
"AliRemoveArgs": "time",
"ConfigId": 1123,
"Status": "success"
},
"ReqAuthConfig": {
"AliAuthWhiteList": "test",
"AuthAddr": "http://test.com/test",
"AuthM3u8": "on",
"AuthRemoteDesc": "test",
"AuthType": "type_c",
"ConfigId": 123,
"Key1": "vadfawerq",
"Key2": "Acbdert",
"Status": "success",
"TimeOut": 2400
},
"ReqHeaderConfigs": {
"ReqHeaderConfig": [
{
"ConfigId": 123,
"Key": "testKey",
"Status": "success",
"Value": "testValue"
}
]
},
"SetVarsConfigs": {
"SetVarsConfig": [
{
"ConfigId": 4125719,
"Status": "success",
"VarName": "typeb",
"VarValue": "typeb"
}
]
},
"SrcHostConfig": {
"ConfigId": 123,
"DomainName": "www.aliyun.com",
"Status": "success"
},
"VideoSeekConfig": {
"ConfigId": 123,
"Enable": "on",
"Status": "success"
},
"WafConfig": {
"ConfigId": 123,
"Enable": "off",
"Status": "success"
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidConfigList.ValueNotSupported | The specified value of parameter ConfigList is not supported. | 指定查询的配置项参数值不合法。 |
400 | MissingParameter | The specified value of parameter "DomainName" is not valid. | 参数“DomainName”的值无效。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交