接口描述:调用本接口查询某域名配置信息
请求方式:get
请求路径:/domain/query-domain-detail
使用说明:单个用户一分钟限制调用10000次,并发不超过100
请求参数说明:
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
product_code | string | 否 | 产品类型 | 产品类型,支持:“001”(静态加速),“003”:(下载加速), “004”(视频点播加速),“008”(CDN加速),“014”(下载加速闲时) |
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加速),“014”(下载加速闲时) |
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< object> | 否 | 源站信息 |
origin[*].origin | string | 否 | 源站ip或域名 |
origin[*].port | int | 否 | 源站端口 |
origin[*].weight | int | 否 | 权重 |
origin[*].role | string | 否 | 源站角色 |
origin[*].protocol | string | 否 | 源站类型 |
xos_origin_is | int | 否 | 是否开启云存储XOS源站配置功能 |
xos_origin | object | 否 | 云存储XOS源站信息 |
xos_origin[*].origin | string | 是 | 云存储XOS源站 |
xos_origin[*].ak | string | 否 | 云存储XOS源站加密ak |
xos_origin[*].sk | string | 否 | 云存储XOS源站加密sk |
black_referer | object | 否 | referer黑名单 |
black_referer.allow_list | list< string> | 否 | referer黑名单列表 |
black_referer.allow_empty | string | 否 | 是否允许为空,“on”(允许为空); “off”(不允许为空) |
black_referer_condition | dict | 否 | referer黑名单condition |
white_referer | object | 否 | referer白名单 |
white_referer.allow_list | list< string> | 否 | referer白名单列表 |
white_referer.allow_empty | string | 否 | 是否允许为空,“on”(允许为空); “off”(不允许为空) |
white_referer_condition | dict | 否 | referer白名单condition |
filetype_ttl | list< object> | 否 | 文件过期时间设置 |
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< object> | 否 | 自定义回源请求头 |
req_headers[*].key | string | 否 | 自定义回源请求头名称 |
req_headers[*].value | string | 否 | 自定义回源请求头值 |
resp_headers | list< object> | 否 | 自定义响应头 |
resp_headers[*].key | string | 否 | 自定义响应头名称 |
resp_headers[*].value | string | 否 | 自定义响应头值 |
basic_conf | object | 否 | http配置基础信息 |
basic_conf.follow302 | int | 否 | 是否拉取跳转后文件,0(否);1(是) |
basic_conf.use_http2 | int | 否 | 是否开启http2,0(不开启);1(开启),该字段只有在证书开启状态下才会有效 |
basic_conf.http_origin_port | int | 否 | http请求回源端口 |
error_code | list< object> | 否 | 错误码缓存配置 |
error_code[*].code | string | 否 | 错误状态码 |
error_code[*].ttl | int | 否 | 缓存时间,单位秒 |
user_agent | object | 否 | user_agent黑白名单配置 |
user_agent.type | int | 否 | 类型,0:(黑名单); 1( 白名单) |
user_agent.ua | list< string> | 否 | user_agent列表 |
https_status | string | 否 | 是否开启https,on、off |
cert_name | string | 否 | 证书备注名 |
https_basic | object | 否 | 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 | object | 否 | 压缩功能 |
gzip.min_length | string | 否 | 压缩文件大小 |
gzip.file_type | string | 否 | 压缩文件类型 |
gzip.type | int | 否 | 压缩类型,0(gzip);1(brotli) |
remote_sync_auth | list< object> | 否 | 远程同步鉴权客户自助 |
remote_sync_auth[*].id | string | 否 | 主键id |
remote_sync_auth[*].priority | int | 否 | 优先级 |
remote_sync_auth[*].auth_host | list< string> | 否 | 鉴权源站 |
remote_sync_auth[*].try_next_remote_server_when | string | 否 | 鉴权源站重试状态码 |
remote_sync_auth[*].subject | string | 否 | subject |
remote_sync_auth[*].pattern | string | 否 | pattern |
remote_sync_auth[*].replace | string | 否 | replace |
remote_sync_auth[*].use_original_request_args | string | 否 | 是否使用原始请求参数 |
remote_sync_auth[*].use_main_request_args_type | string | 否 | 使用原始请求参数类型 |
remote_sync_auth[*].use_main_request_args | list< object> | 否 | 请求参数 |
remote_sync_auth[*].use_main_request_args[].arg_name | string | 否 | 请求参数key |
remote_sync_auth[*].use_main_request_args[].arg_value | string | 否 | 请求参数value |
remote_sync_auth[*].use_original_request_headers | string | 否 | 是否使用原始请求头 |
remote_sync_auth[*].use_main_request_headers_type | string | 否 | 使用原始请求头类型 |
remote_sync_auth[*].use_main_request_headers | list< object> | 否 | 请求头 |
remote_sync_auth[*].use_main_request_headers[].arg_name | string | 否 | 请求头key |
remote_sync_auth[*].use_main_request_headers[].arg_value | string | 否 | 请求头value |
remote_sync_auth[*].auth_scheme | string | 否 | 请求协议 |
remote_sync_auth[*].auth_port | int | 否 | 请求端口 |
remote_sync_auth[*].auth_method | string | 否 | 请求方法 |
remote_sync_auth[*].auth_body_data | string | 否 | 请求体 |
remote_sync_auth[*].auth_timeout | float | 否 | 鉴权超时时间,单位秒 |
remote_sync_auth[*].auth_connection_pool_size | int | 否 | 鉴权服务端连接池大小 |
remote_sync_auth[*].auth_connection_idle_time | int | 否 | 连接空闲超时时间 |
remote_sync_auth[*].auth_timeout_pass | string | 否 | 鉴权超时是否通过,取值:on:是,off:否 |
remote_sync_auth[*].auth_error_pass | string | 否 | 鉴权出错是否通过,取值:on:是,off |
remote_sync_auth[*].auth_respond_action | string | 否 | 鉴权状态码黑白名单,白名单 “allow” 或 黑名单 “deny” |
remote_sync_auth[*].auth_respond_status | list< int> | 否 | 状态码 |
remote_sync_auth[*].forbidden_code_state | string | 否 | 鉴权不通过时状态码设置 |
remote_sync_auth[*].forbidden_code | int | 否 | 固定状态码 |
remote_sync_auth[*].response_json_to_var | object | 否 | 基于json鉴权 |
remote_sync_auth[*].response_json_to_var.switch | int | 否 | 0关,1开 |
remote_sync_auth[*].response_json_to_var.json_var_list | list< object> | 否 | json数据 |
remote_sync_auth[*].response_json_to_var.json_var_list[].arg_name | string | 否 | 变量名 |
remote_sync_auth[*].response_json_to_var.json_var_list[].arg_value | string | 否 | 变量值 |
remote_sync_auth[*].response_json_to_var.forbidden_code | int | 否 | 鉴权不通过状态码 |
remote_sync_auth_condition | object | 否 | 远程同步鉴权condition,{“key”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]}, mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径 key为remote_sync_auth中的id |
ip_black_list | string | 否 | ip黑名单 |
ip_white_list | string | 否 | ip白名单 |
req_host | string | 否 | 回源host |
shared_host | string | 否 | 共享缓存域名 |
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 | object | 否 | 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 | object | 否 | limit_speed_const的condition配置 |
backorigin_uri_rewrite_condition | object | 否 | 回源uri改写condition配置 |
md5_secure_time | list< object> | 否 | md5时间戳防盗链 |
md5_secure_time[*].delim_time_char | string | 否 | md5加密方式分隔符 |
md5_secure_time[*].element | list< object> | 否 | 加密元素设置 |
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 | object | 否 | 加密元素condition设置 |
gzip_condition | object | 否 | 文件压缩condition配置 |
backorigin_uri_rewrite | object | 否 | 回源uri改写 |
ssl | string | 否 | ssl协议类型,支持TLSv1 、TLSv1.1 、TLSv1.2 、TLSv1.3 ,仅在https_status为on时才生效 |
ssl_stapling | string | 否 | ocsp stapling开关,on(开启),off(关闭),仅在https_status为on时才生效 |
cus_gzip | list< object> | 否 | 文件压缩 |
cus_gzip[*].id | string | 否 | id |
cus_gzip[*].min_length | string | 否 | 压缩文件大小 |
cus_gzip[*].file_type | string | 否 | 压缩文件类型 |
cus_gzip[*].type | int | 否 | 压缩类型,取值:0(gzip),1(brotli) |
cus_gzip[*].http_version | string | 否 | http_version,取值:1.1 ,1.0 |
cus_gzip[*].vary | string | 否 | gzip_vary,取值:on(开启),off(关闭) |
cus_gzip[*].max_length | string | 否 | 最大文件大小 |
cus_gzip_condition | dict | 否 | 文件压缩condition配置,{“key”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]}, mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径。key为cus_gzip中的id |
entry_limits | list< object> | 否 | 限频自助参数 |
entry_limits[*].id | string | 否 | 唯一id |
entry_limits[*].limit_element | string | 否 | 限制参数 |
entry_limits[*].frequency_threshold | int | 否 | 访问次数限制阈值 |
entry_limits[*].frequency_time_range | int | 否 | 统计周期 |
entry_limits[*].forbidden_duration | int | 否 | 拒绝访问时间 |
entry_limits[*].forbidden_duration_unit | string | 否 | 拒绝访问时间单位,取值范围:[s,millis],默认s |
entry_limits[*].forbidden_code | int | 否 | 封禁http访问码 |
entry_limits[*].white_ip_control | list< string> | 否 | 不执行校验的客户端ip |
entry_limits[*].priority | int | 否 | 优先级 |
entry_limits_condition | dict | 否 | 限频自助参condition配置,,{“key”:[{“mode”:类型, “content”:“配置内容,多个以逗号间隔”}]}, mode取值:默认0, 0:文件后缀 1:目录 2: 首页 3: 全部文件 4: 全路径。key为entry_limits中的id |
cachekey_args | list< object> | 否 | 缓存参数 |
cachekey_args[*].id | string | 是 | 基于缓存参数唯一标识 |
cachekey_args[*].ignore | int | 否 | 去参数缓存开关。取值:0:否,1 是 |
cachekey_args[*].is_with_args | int | 否 | 带特定参数缓存。取值:0:否,1 是 |
cachekey_args[*].mode | int | 否 | 匹配方式。取值:0:否,1 是 |
cachekey_args[*].args | string | 否 | 匹配方式为0时配置的参数 |
cachekey_args[*].subject | string | 否 | 匹配方式为1时配置,目前没用 |
cachekey_args[*].pattern | string | 否 | 匹配方式为1时配置,目前没用 |
cachekey_args[*].replace | string | 否 | 匹配方式为1时配置,目前没用 |
cachekey_args[*].priority | int | 否 | 优先级,取值范围[1,100] |
cachekey_args[*].ignore_args | string | 否 | 忽略特定参数缓存,多个参数中间用逗号分割 |
cachekey_args_condition | dict | 否 | 缓存参数condition配置 |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/domain/query-domain-detail
示例1:
请求:https://cdnapi-global.ctapi.ctyun.cn/domain/query-domain-detail?domain=test.ctyun.cn&product_code=001
返回结果:
{
"code": 100000,
"message": "success",
"domain": "aaa.ctyun.cn",
"product_code": "001",
"area_scope": 1,
"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": "aaa.ctyun.cn.ctdns.cn",
"status": 4,
"ipv6_enable": 2,
"origin_host_type": 0,
"basic_conf": {
"follow302": 0,
"use_http2": 0,
"http_origin_port": 80,
"https_origin_port": 8080
},
"filetype_ttl": [
{
"mode": 0,
"file_type": "php,ashx,aspx,asp,jsp,do",
"cache_type": 3,
"priority": 10,
"ttl": 0,
"cache_with_args": 0
}
],
"origin": [
{
"protocol": "http",
"role": "master",
"port": 80,
"origin": "1.1.1.1",
"weight": 10
},
{
"role": "master",
"port": 80,
"origin": "test.hnoss.xstore.ctyun.cn",
"weight": 10
}
],
"xos_origin_is": 1,
"xos_origin": {
"origin": "test.hnoss.xstore.ctyun.cn",
"ak": "akxxx",
"sk": "skxxx"
},
"entry_limits": [
{
"id": "123abc",
"limit_element": "entry_limits",
"frequency_threshold": 0,
"frequency_time_range": 3600,
"forbidden_duration": 1000,
"forbidden_duration_unit": "s",
"forbidden_code": 0,
"white_ip_control": [
"1.1.1.11",
"58.14.0.0/15",
"240e:94a:4001::3007"
],
"priority": 100
},
{
"id": "456abc",
"limit_element": "entry_limits",
"frequency_threshold": 1000,
"frequency_time_range": 3000,
"forbidden_duration": 1000,
"forbidden_duration_unit": "millis",
"forbidden_code": 123,
"white_ip_control": [
"192.168.1.1",
"58.14.0.0/15",
"240e:94a:4001::3007"
],
"priority": 1
}
],
"entry_limits_condition": {
"123abc": [
{
"mode": 1,
"content": "/test1,/test2"
}
],
"456abc": [
{
"mode": 4,
"content": "/test3$,/test4"
}
]
},
"gzip": {
"id": "gzip",
"min_length": "1K",
"file_type": "tar",
"type": 1
},
"gzip_condition": {
"gzip": [
{
"mode": 1,
"content": "?/test1,/test2"
}
]
},
"cus_gzip": [
{
"id": "123abc",
"min_length": "1K",
"file_type": "tar",
"type": 1,
"http_version": "1.1",
"vary": "on",
"max_length": "1M"
},
{
"id": "123abcd",
"min_length": "1M",
"file_type": "zip",
"type": 0,
"http_version": "1.0",
"vary": "off",
"max_length": "1000M"
}
],
"cus_gzip_condition": {
"123abc": [
{
"mode": 1,
"content": "/test1,/test2"
}
],
"123abcd": [
{
"mode": 4,
"content": "/test3,/test4"
}
]
},
"cachekey_args": [
{
"id": "cachekey_args1234561231",
"ignore": 0,
"is_with_args": 1,
"mode": 1,
"args": " ",
"priority": 10,
"ignore_args": "xxx",
"subject": "xxx",
"pattern": "xxx",
"replace": "xxx"
},
{
"id": "cachekey_args123456abd@12"
}
],
"cachekey_args_condition": {
"cachekey_args123456abd@12": [
{
"mode": 2,
"content": "/"
}
]
}
}
错误码请参考:参数code和message含义