接口描述:调用本接口查询某域名配置信息
请求方式:get
请求路径:/domain/query-domain-detail
使用说明:单个用户一分钟限制调用10000次,并发不超过100
请求参数说明:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
product_code | string | 否 | 产品类型 | 产品类型,“006”(全站加速),不传代表全部产品 |
domain | string | 是 | 域名 | |
function_names | string | 否 | 功能函数名称 | 若该参数不传,则默认返回的是该域名全部功能的配置参数,若传该参数,则返回指定功能的配置信息,多个功能用英文逗号分割,若该参数未配置,可能返回为空,目前支持参数:black_referer(referer黑名单),white_referer(referer白名单),filetype_ttl(文件过期时间设置),ip_black_list(ip黑名单),ip_white_list(ip白名单),req_headers(自定义回源请求头),resp_headers(自定义响应头),req_host(回源host),error_code(错误码缓存配置),shared_host(共享缓存域名) |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码,成功100000 |
message | string | 是 | 描述信息,成功返回success,其他返回异常信息描述 |
domain | string | 否 | 域名 |
status | int | 否 | 域名状态,4(已启用);6(已停止)。域名详情只返回域名的确定状态,过程中的状态不会返回。 |
product_code | string | 否 | 产品类型,“001”(静态加速),“003”:(下载加速), “004”(视频点播加速),“008”(CDN加速),“006”(全站加速) |
area_scope | int | 否 | 加速范围 |
cname | string | 否 | cname |
insert_date | string | 否 | 创建时间,单位毫秒 |
status_date | string | 否 | 修改时间,单位毫秒 |
ipv6_enable | int | 否 | ipv6启用,1(启用 );2(关闭) |
record_num | string | 否 | 备案号 |
record_status | string | 否 | 备案状态,false(未备案);ture(已备案) |
origin_host_type | int | 否 | 主备源携带不同的回源host是否开启,0(关闭);1(开启) |
origin_protocol | string | 否 | 回源协议,http(用http协议回源);https(用https协议回源);follow_request(跟随访问协议进行回源) |
origin | list | 否 | 源站信息 |
origin[*].origin | string | 否 | 源站ip或域名 |
origin[*].port | int | 否 | 源站端口 |
origin[*].weight | int | 否 | 权重 |
origin[*].role | string | 否 | 源站角色 |
origin[*].protocol | string | 否 | 源站类型 |
black_referer | dict | 否 | referer黑名单 |
black_referer.allow_list | list | 否 | referer黑名单列表 |
black_referer.allow_empty | string | 否 | 是否允许为空,“on”(允许为空); “off”(不允许为空) |
white_referer | dict | 否 | referer白名单 |
white_referer.allow_list | list | 否 | referer白名单列表 |
white_referer.allow_empty | string | 否 | 是否允许为空,“on”(允许为空); “off”(不允许为空) |
filetype_ttl | list | 否 | 文件过期时间设置 |
filetype_ttl[*].file_type | string | 否 | 缓存文件类型,多个以逗号隔开 |
filetype_ttl[*].ttl | int | 否 | 缓存时间,单位秒 |
filetype_ttl[*].cache_type | int | 否 | 缓存类型, 1(不缓存);2(优先遵循源站);3(强制缓存) |
filetype_ttl[*].cache_with_args | int | 否 | 是否带参数缓存,0(不带参数缓存);1(带参数缓存) |
filetype_ttl[*].mode | int | 否 | 模式, 0(文件后缀);1(目录);2(首页); 3(全部文件);4(全路径);5(正则),不传默认0 |
filetype_ttl[*].priority | int | 否 | 优先级 |
req_headers | list | 否 | 自定义回源请求头 |
req_headers[*].key | string | 否 | 自定义回源请求头名称 |
req_headers[*].value | string | 否 | 自定义回源请求头值 |
resp_headers | list | 否 | 自定义响应头 |
resp_headers[*].key | string | 否 | 自定义响应头名称 |
resp_headers[*].value | string | 否 | 自定义响应头值 |
basic_conf | dict | 否 | http配置基础信息 |
basic_conf.follow302 | int | 否 | 是否拉取跳转后文件,0(否);1(是) |
basic_conf.use_http2 | int | 否 | 是否开启http2,0(不开启);1(开启),该字段只有在证书开启状态下才会有效 |
error_code | list | 否 | 错误码缓存配置 |
error_code[*].code | string | 否 | 错误状态码 |
error_code[*].ttl | int | 否 | 缓存时间,单位秒 |
user_agent | dict | 否 | user_agent黑白名单配置 |
user_agent.type | int | 否 | 类型,0:(黑名单); 1( 白名单) |
user_agent.ua | list | 否 | user_agent列表 |
https_status | string | 否 | 是否开启https,on、off |
https_basic | dict | 否 | https基础配置 |
https_basic.https_force | string | 否 | https强制跳转,“on”(跳转);“off”(不跳转) |
https_basic.http_force | string | 否 | http强制跳转,“on”(跳转);“off”(不跳转) |
https_basic.force_status | string | 否 | 强制跳转状态码 |
https_basic.origin_protocol | string | 否 | https回源协议,http(用http协议回源);https(用https协议回源);follow_request(跟随访问协议进行回源) |
gzip | dict | 否 | 压缩功能 |
gzip.min_length | string | 否 | 压缩文件大小 |
gzip.file_type | string | 否 | 压缩文件类型 |
gzip.type | int | 否 | 压缩类型,0(gzip);1(brotli) |
ip_black_list | string | 否 | ip黑名单 |
ip_white_list | string | 否 | ip白名单 |
req_host | string | 否 | 回源host |
shared_host | string | 否 | 共享缓存域名 |
live_conf | dict | 否 | 直播加速信息,当前为空 |
limit_speed_uri | list<object> | 否 | 基于url参数限速 |
limit_speed_uri[*].id | string | 否 | limit_speed_uri列表内唯一 |
limit_speed_uri[*].unit | string | 否 | 单位 |
limit_speed_uri[*].args | string | 否 | uri参数名 |
limit_speed_uri[*].time_seg | string | 否 | 时段 |
limit_speed_uri[*].weight | int | 否 | 优先级 |
limit_speed_uri_condition | dict | 否 | limit_speed_uri的condition配置 |
limit_speed_const | list<object> | 否 | 基于固定值限速 |
limit_speed_const[*].id | string | 否 | 基于固定值限速唯一标识,limit_speed_const列表内唯一 |
limit_speed_const[*].rate | int | 否 | 限速值 |
limit_speed_const[*].time_seg | string | 否 | 时段 |
limit_speed_const[*].unit | string | 否 | 单位 |
limit_speed_const[*].weight | int | 否 | 优先级 |
limit_speed_const_condition | dict | 否 | limit_speed_const的condition配置 |
backorigin_arg_rewrite | dict | 否 | 回源参数改写 |
backorigin_uri_rewrite_condition | dict | 否 | 回源uri改写condition配置 |
backorigin_arg_rewrite_condition | dict | 否 | 回源参数改写condition配置 |
md5_secure_time | list<object> | 否 | md5时间戳防盗链 |
md5_secure_time[*].delim_time_char | string | 否 | md5加密方式分隔符 |
md5_secure_time[*].element | list<dict> | 否 | 加密元素设置 |
md5_secure_time[*].forbidden_code | int | 否 | 校验不通过状态码,默认403 |
md5_secure_time[*].id | string | 否 | 配置名,唯一标识 |
md5_secure_time[*].md5_arg | string | 否 | md5校验参数名称 |
md5_secure_time[*].md5_forbidden_code | int | 否 | md5校验不通过状态码 |
md5_secure_time[*].md5_path | int | 否 | md5校验码位置 |
md5_secure_time[*].md5_path_custom | string | 否 | 自定义目录 |
md5_secure_time[*].md5_path_level | int | 否 | 目录级别 |
md5_secure_time[*].md5_pattern | string | 否 | md5模式名称 |
md5_secure_time[*].md5_replace | string | 否 | md5替代内容 |
md5_secure_time[*].md5_switch | int | 否 | md5校验开关 |
md5_secure_time[*].priority | int | 否 | 权重 |
md5_secure_time[*].time_arg | string | 否 | 参数名称 |
md5_secure_time[*].time_format | int | 否 | 时间戳格式 |
md5_secure_time[*].time_lower_limit | int | 否 | 可访问起始时长 |
md5_secure_time[*].time_md5_length | int | 否 | md5校验长度 |
md5_secure_time[*].time_md5_start | int | 否 | md5校验起始位置 |
md5_secure_time[*].time_path | int | 否 | 时间戳位置 |
md5_secure_time[*].time_path_custom | string | 否 | 自定义目录 |
md5_secure_time[*].time_path_level | int | 否 | 目录级别 |
md5_secure_time[*].time_pattern | string | 否 | time模式名称 |
md5_secure_time[*].time_replace | string | 否 | time替代内容 |
md5_secure_time[*].time_switch | int | 否 | 时间戳校验开关 |
md5_secure_time[*].time_upper_limit | int | 否 | 时间戳有效期 |
md5_secure_time_condition | dict | 否 | 加密元素condition设置 |
cachekey_args_condition | dict | 否 | 缓存参数的condition配置 |
ignore_backorigin_args | int | 否 | 是否忽略回源参数 |
gzip_condition | dict | 否 | 文件压缩condition配置 |
ip_deny_mode | int | 否 | ip黑白名单匹配方式 |
cachekey_args | list<object> | 否 | 缓存参数 |
cachekey_args[*].args | string | 否 | 匹配方式为0时配置的参数 |
cachekey_args[*].id | string | 否 | 基于缓存参数唯一标识 |
cachekey_args[*].ignore | int | 否 | 去参数缓存开关 |
cachekey_args[*].ignore_args | string | 否 | 忽略特定参数缓存 |
cachekey_args[*].is_with_args | int | 否 | 带特定参数缓存 |
cachekey_args[*].mode | int | 否 | 匹配方式 |
cachekey_args[*].pattern | string | 否 | 匹配方式为1时配置,目前没用 |
cachekey_args[*].priority | int | 否 | 优先级 |
cachekey_args[*].replace | string | 否 | 匹配方式为1时配置,目前没用 |
cachekey_args[*].subject | string | 否 | 匹配方式为1时配置,目前没用 |
content_check_switch | int | 否 | 内容审核开关 |
xff_header | str | 否 | 传递客户端ip头部设置 |
etag_lm_check | int | 否 | 分片Etag和LM检查开关 |
complex_resp_header | dict | 否 | 复杂模式响应头 |
referer_illegal_code | int | 否 | 非法请求状态码referer |
backorigin_uri_rewrite | dict | 否 | 回源uri改写 |
follow302_is_valid | int | 否 | follow302后是否有效 |
path_ttl | list<object> | 否 | 路径配置 |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/domain/query-domain-detail
请求:https://cdnapi-global.ctapi.ctyun.cn/domain/query-domain-detail?domain=aaa.ctyun.cn&product_code=006
返回结果:
{ "code": 100000, "message": "success", "domain": "aaa.ctyun.cn", "product_code": "006", "area_scope": 1, "origin": [ { "protocol": "http", "role": "master", "port": 80, "origin": "1.1.1.1", "weight": 10 } ], "black_referer": {}, "white_referer": {}, "filetype_ttl": [ { "mode": 0, "file_type": "php,ashx,aspx,asp,jsp,do", "cache_type": 3, "priority": 10, "ttl": 0, "cache_with_args": 0 }, { "mode": 0, "file_type": "js,css,xml,htm,html", "cache_type": 3, "priority": 10, "ttl": 1800, "cache_with_args": 0 }, { "mode": 0, "file_type": "swf,jpg,gif,png,bmp,ico,ts", "cache_type": 3, "priority": 10, "ttl": 86400, "cache_with_args": 0 }, { "mode": 0, "file_type": "wmv,mp3,wma,ogg,flv,mp4,avi,mpg,mpeg,f4v,hlv,rmvb,rm,3gp,img,bin,zip,rar,ipa,apk,jar,sis,xap,msi,exe,cab,7z,pdf,doc,docx,xls,xlsx,ppt,pptx,txt", "cache_type": 3, "priority": 10, "ttl": 31536000, "cache_with_args": 0 } ], "req_headers": [], "resp_headers": [], "live_conf": {}, "basic_conf": { "follow302": 0, "use_http2": 0 }, "error_code": [], "user_agent": {}, "https_status": "off", "https_basic": { "https_force": "off", "force_status": "302", "origin_protocol": "http", "http_force": "off" }, "record_num": "京ICP证030173号-1", "record_status": "true", "insert_date": "1657177732000", "status_date": "0", "cname": "ctyun.cn.ctdns.cn.", "status": 4, "ipv6_enable": 2, "origin_host_type": 0, "gzip": {}, "ip_black_list": "", "ip_white_list": "", "req_host": "", "shared_host": "", "origin_protocol": "http" }
错误码请参考:参数code和message含义