客服电话：13904310313 
域名相关七牛云
创建域名
拷贝用户创建普通及泛域名接口
请求包
拷贝POST /domain/HTTP/1.1Content-Type: application/jsonAuthorization: QBox { // 基本配置 'type': , 'platform': , 'geoCover': , 'protocol': ,'ipTypes': , // 回源配置 'source': , // 缓存配置 'cache': , // referer 防盗链 'referer': , // ip 黑白名单 'ipACL': , // 时间戳防盗链 'timeACL': , // 回源鉴权 'bsauth': , // htttps 配置 'https': , // 其他特殊配置 'external': , // 备案号 'registerNo': }
参数解释
基本参数
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Name | string | 是 | 域名, 如果是泛域名，必须以点号 . 开头 |
| Type | string | 是 | 域名类型: normal(普通域名)/wildcard(泛域名) |
| Platform | string | 是 | 平台类型: web(网页)/download(下载)/vod(点播)/ dynamic(动态加速) |
| GeoCover | string | 是 | 地域: china/foreign/global |
| Protocol | string | 是 | 协议: http/https |
| Source | 请参考 回源配置 | 是 | 回源参数 |
| Cache | 请参考 缓存策略 | 备注：平台是动态加速是“否”，其他平台为“是” | 缓存参数 |
| Referer | 请参考 referer防盗链 | 否 | 防盗链参数 |
| IPACL | 请参考 ip黑白名单 | 否 | ip 黑白名单参数 |
| TimeACL | 请参考 时间戳防盗链 | 否 | 时间戳防盗链参数 (备注：平台是动态加速不支持时间戳防盗链) |
| Bsauth | 请参考 回源鉴权 | 否 | 回源鉴权参数(备注：平台是动态加速不支持回源鉴权) |
| HTTPS | 请参考 HTTPS | 否 | HTTPS参数 |
| External | 请参考 特殊配置 | 否 | 其他特殊配置参数 |
| RegisterNo | string | 否 | 当创建域名返回code: 500230 或者返回的内容提示为备案查询服务已关闭，需要API调用者在本参数输入域名的备案号 |
| IpTypes | uint | 否 | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。不指定IPTypes时，国内/全球域名默认为允许ipv4/ipv6访问，海外域名仅允许ipv4访问。 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400001 | 非法域名 |
| 400005 | 未知的协议 |
| 400020 | 域名未备案 |
| 400040 | 非法的回源域名 |
| 400044 | 非法的回源host |
| 400041 | 未知的回源ip |
| 400008 | 无此bucket |
| 400345 | 共享bucket不能绑定域名 |
| 400043 | 未知的高级回源参数 |
| 400022 | 未知的测试url |
| 400002 | 未知的回源类型 |
| 400093 | 非法的域名类型 |
| 400060 | 未知的referer防盗链类型 |
| 400061 | 未知的referer防盗链参数 |
| 400091 | 缓存参数有误 |
| 400309 | 缓存规则未设置全局或者为遵循源站 |
| 400204 | 时间戳防盗链key值数目不够 |
| 400031 | 非法的url |
| 400203 | 已禁用的用户 |
| 400541 | 获取用户信息失败 |
| 401000 | 未实名认证的用户 |
| 400801 | 未知的vendor |
| 400003 | 未知的平台类型 |
| 400004 | 未知覆盖 |
| 404911 | 非法的路径 |
| 404912 | 非法的正则表达式 |
| 400520 | 不能同时设置时间戳防盗链和回源鉴权 |
| 400200 | 未知的bucket |
| 400521 | 非法的回源鉴权地址 |
| 400522 | 非法的回源鉴权http方法 |
| 400523 | 非法的回源鉴权http code |
| 400524 | 非法的回源鉴权超时时间 |
| 400525 | 非法的回源鉴权url参数 |
| 400401 | 无此证书 |
| 400324 | https证书解码失败 |
| 400325 | https证书解析失败 |
| 400321 | https证书还未生效 |
| 400329 | https证书过期 |
| 400326 | https证书与域名不匹配 |
| 400327 | 解析https证书密钥失败 |
| 400328 | https证书与密钥不匹配 |
| 400323 | 验证https证书链失败 |
| 400549 | 只有https域名才能使用强制https跳转 |
| 400621 | 泛域名及其子域名不能使用私有bucket |
| 400005 | 未知的协议 |
| 400332 | 未知的回源协议 |
| 500219 | 查询证书内部错误 |
| 500005 | 数据查询内部出错 |
| 500230 | 备案查询服务已关闭 |
| 500000 | 未知内部错误 |
请求示例
拷贝POST /domain/testqiniu.qbox.net HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'protocol': 'http','platform': 'web','geocover': 'china','type': 'normal','ipTypes': 3,'source': {'sourceType': 'bucket','sourceQiniuBucket': 'test','testURLPath': 'qiniu_do_not_delete.gif'},'cache': {'cacheControls': [{'time': 0,'timeunit': 0,'type': 'suffix','rule': '.m3u8;.js'},{'time': 1,'timeunit': 5,'type': 'all','rule': '*'}],'ignoreParam': true},'referer': {'refererType': 'white','refererValues': ['*.qiniu.com','qiniu.com'],'nullReferer': true},'timeACL': {'enable': true,'timeACLKeys': ['abcdefghijklmnopqrstuvwxyz','zyxwvutsrqponmlkjihgfedcba'],'checkUrl': 'http://xxx.yyy.com/DIR1/dir2/vodfile.mp4?v=1.1&sign=19eb212771e87cc3d478b9f32d6c7bf9&t=55bb9b80'},'ipACL': {'ipACLType': 'black','ipACLValues': ['115.223.202.9']},'external': {'enableFop': true,'imageSlim': {'enableImageSlim': true,'prefixImageSlims': ['/abc','/def']}}}创建泛子域名
拷贝用户创建泛子域名接口，泛子域名必须回源七牛云存储的bucket。每个泛域名只能创建一级泛子域名，例如：.a.com 的泛域名只能创建 123.a.com的泛子域名。
请求包
拷贝POST /pandomain/Content-Type: application/jsonAuthorization: QBox { 'bucket': , 'pareDomain': }
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Name | string | 是 | 域名（支持一级泛子域名） |
| Bucket | string | 是 | 要绑定的bucket名称 |
| PareDomain | string | 是 | 泛子域名所属的泛域名 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400203 | 已禁用的用户 |
| 400095 | 未知的父域名 |
| 400008 | 无此bucket |
| 400412 | 无效的泛子域名 |
| 500011 | pub域名到bucket失败 |
| 500002 | 新增数据内部出错 |
请求示例
拷贝POST /pandomain/testqiniu.qbox.net HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'bucket': 'test','pareDomain': '.qbox.net'}调整覆盖
拷贝用户修改普通域名及泛域名区域覆盖接口
请求包
拷贝PUT /domain//geocoverContent-Type: application/jsonAuthorization: QBox {'geoCover': }
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Name | string | 是 | 域名 |
| GeoCover | string | 是 | 地域: china/foreign/global（中国大陆/海外/全球） |
返回包
拷贝{ 200 }错误码
| 错误码 | 含义 |
|---|---|
| 400001 | 非法域名 |
| 400004 | 未知覆盖 |
| 400108 | 覆盖冲突 |
| 400020 | 域名未备案 |
| 400030 | 正在处理中 |
| 400064 | 无权处理该域名 |
| 400066 | 域名状态为失败 |
| 400078 | 未备案的海外域名，对七牛资源的使用错误 |
| 400093 | 非法的域名类型 |
| 400313 | 域名有手动配置的时间戳防盗链 |
| 400923 | 域名已冻结 |
| 400998 | 域名已下线 |
| 404001 | 无此域名 |
| 500000 | 未知内部错误 |
| 500005 | 数据查询内部出错 |
| 500930 | 不能操作已删除的域名 |
修改源站
拷贝用户修改普通域名及泛域名源站接口
请求包
拷贝PUT /domain//sourceContent-Type: application/jsonAuthorization: QBox { Source}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Source | object | 是 | Source结构请参考 回源配置 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400001 | 非法域名 |
| 404001 | 无此域名 |
| 400093 | 非法的域名类型 |
| 400801 | 未知的vendor |
| 400018 | 非法的cname |
| 400005 | 未知的协议 |
| 400046 | 非法的url重写规则 |
| 400022 | 非法的测试url |
| 400024 | 验证源站访问性失败 |
| 500005 | 数据查询内部出错 |
| 500019 | 非标准的回源cname |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/source HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'sourceType': 'ip','sourceIPs': ['1.1.1.1','1.1.1.2'],'testURLPath': 'test.gif'}修改Range回源
拷贝用户修改普通域名及泛域名Range回源接口
请求包
拷贝PUT /domain//rangeContent-Type: application/jsonAuthorization: QBox { 'enable': }
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Enable | string | 是 | Range回源开关：on/off |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400200 | 未知的bucket |
| 400008 | 无此bucket |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 500923 | 域名已冻结 |
| 500930 | 删除中的域名 |
| 400957 | 无效的Range配置 |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/range HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'enable': 'on'}修改缓存规则
拷贝用户修改普通域名及泛域名缓存规则接口
请求包
拷贝PUT /domain//cacheContent-Type: application/jsonAuthorization: QBox { Cache}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Cache | object | 是 | Cache结构请参考 缓存策略 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400001 | 未知的域名 |
| 404001 | 无此域名 |
| 400064 | 无权处理该域名 |
| 400093 | 非法的域名类型 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 400091 | 缓存参数有误 |
| 400309 | 缓存规则未设置全局或者为遵循源站 |
| 500005 | 数据查询内部出错 |
| 400923 | 域名已冻结 |
| 500930 | 删除中的域名 |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/cache HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'cacheControls': [{'time': 0,'timeunit': 0,'type': 'suffix','rule': '.m3u8;.js'},{'time': 1,'timeunit': 5,'type': 'all','rule': '*'}],'ignoreParam': true}下线域名
拷贝用户下线普通及泛域名接口
请求包
拷贝POST /domain//offlineContent-Type: application/jsonAuthorization: QBox
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400093 | 非法的域名类型 |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400018 | 非法的cname |
| 400397 | cname和其他域名冲突 |
| 400923 | 域名已冻结 |
| 500005 | 数据查询内部出错 |
上线域名
拷贝用户上线普通及泛域名接口
请求包
拷贝POST /domain//onlineContent-Type: application/jsonAuthorization: QBox
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400093 | 非法的域名类型 |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400018 | 非法的cname |
| 400397 | cname和其他域名冲突 |
| 500004 | 更新数据内部出错 |
| 500923 | 域名已冻结 |
| 500005 | 数据查询内部出错 |
| 500235 | 该域名未绑定证书 |
删除域名
拷贝用户删除普通及泛域名接口
请求包
拷贝DELETE /domain/Content-Type: application/jsonAuthorization: QBox
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400317 | 非已下线的域名 |
| 400066 | 域名状态为失败 |
| 400515 | 该泛域名还含有活跃的子域名 |
| 500005 | 数据查询内部出错 |
获取域名信息
拷贝用户获取域名信息接口，所有域名适用
请求包
拷贝GET /domain/Content-Type: application/x-www-form-urlencodedAuthorization: QBox
返回包
拷贝{ 'name': , 'type': , 'cname': , 'testURLPath': , 'platform': , 'geoCover': , 'protocol': ,'ipTypes': ,'tagList': ,'kvTagList': 'source': , 'cache': , 'referer': , 'ipACL': , 'timeACL': , 'bsauth': , 'operationType': , 'operatingState': , 'operatingStateDesc': , 'createAt': , 'modifyAt': , 'pareDomain': , 'https': } 参数解释
基本参数 请参考
| 参数 | 类型 | 含义 |
|---|---|---|
| CName | string | 创建域名成功后七牛生成的域名，用户需要把 Name cname 到这个域名 |
| Referer | object | Referer结构请参考 referer防盗链 |
| IPACL | object | IPACL结构请参考 ip黑白名单 |
| TimeACL | object | TimeACL结构请参考 时间戳防盗链 |
| Bsauth | object | Bsauth结构请参考 回源鉴权 |
| Source | object | Source结构请参考 回源配置 |
| Cache | object | Cache结构请参考 缓存策略 |
| OperationType | string | 域名最近一次操作类型: create_domain/offline_domain/online_domain/ modify_source/modify_referer/modify_cache/ freeze_domain/unfreeze_domain/modify_timeacl(修改时间戳防盗链)/ modify_https_crt/sslize(升级HTTPS)/modify_bsauth(修改回源鉴权) /offline_bsauth(删除回源鉴权) |
| OperatingState | string | 域名最近一次的操作状态: processing/success/failed/frozen/offlined |
| OperatingStateDesc | string | 域名最近一次的操作状态的描述 |
| CreateAt | string | 域名创建时间，格式:RFC3339 |
| ModifyAt | string | 域名最后一次修改时间，格式:RFC3339 |
| PareDomain | string | 父域名,属于泛子域名字段 |
| Https | Object | Https结构请参考 HTTPS |
| IpTypes | uint | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。 |
| TagList | []string | 域名的标签列表（废弃） |
| kvTagList | []Object | 域名的Key-Value标签列表 |
错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400014 | 无权获取该域名 |
| 500005 | 数据查询内部出错 |
获取域名列表
拷贝用户获取域名列表接口，所有域名适用
请求包
拷贝GET /domain?types=&certId= &sourceTypes= &sourceQiniuBucket= &sourceIp= &marker= &limit= Content-Type: application/x-www-form-urlencodedAuthorization: QBox
参数解释
| 参数 | 类型 | 含义 |
|---|---|---|
| Types | []string | 域名类型，可选normal（普通域名）、wildcard（泛域名）、pan（泛子域名）、test（测试域名）中的一个或多个，不填默认查询全部域名。 |
| CertId | string | 证书ID，不填默认查询全部域名。 |
| SourceTypes | []string | 回源类型，可选domain、ip、qiniuBucket、advanced中的一个或多个，不填默认查询全部域名；如果指定了SourceQiniuBucket参数，SourceTypes只能指定为qiniuBucket一种回源类型，否则SourceQiniuBucket参数将不生效；如果指定了SourceIp参数，SourceTypes只能指定为ip一种回源类型，否则SourceIp参数将不生效；同时获取多种回源类型域名的请求url示例：http://api.qiniu.com/domain?sourceTypes=domain&sourceTypes=ip。 |
| SourceQiniuBucket | string | 七牛存储空间名称，不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=qiniuBucket&sourceQiniuBucket=test。 |
| SourceIp | string | 回源IP, 不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=ip&sourceIp=1.1.1.1。 |
| Marker | string | 用于标示从哪个位置开始获取域名列表，不填或空表示从头开始。 |
| Limit | int | 返回的最大域名个数。1~1000, 不填默认为 10 |
返回包
拷贝{ 'marker': , 'domains': [ { 'name': , 'type': , 'cname': , 'testURLPath': , 'platform': , 'geoCover': , 'protocol': , 'operatingState': , 'operatingStateDesc': , 'createAt': , 'modifyAt': }, ... ]} 参数解释
基本参数 请参考
| 参数 | 类型 | 含义 |
|---|---|---|
| Marker | string | 用于标示下一次从哪个位置开始获取域名列表 |
| CName | string | 创建域名成功后七牛生成的域名，用户需要把 Name cname 到这个域名 |
| TestURLPath | string | 域名的测试资源，需要保证这个资源是可访问的 |
| IpTypes | uint | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。 |
| TagList | []string | 域名的标签列表（废弃） |
| KvTagList | []Object | 域名的Key-Value标签列表 |
| OperatingState | string | 域名最近一次的操作状态: processing/success/failed/frozen/offlined |
| CreateAt | string | 域名创建时间，格式:RFC3339 |
| ModifyAt | string | 域名最后一次修改时间，格式:RFC3339 |
错误码
| 错误码 | 含义 |
|---|---|
| 400021 | 非法的参数marker |
| 500005 | 数据查询内部出错 |
HTTP升级为HTTPS
拷贝HTTP升级为HTTPS
请求包
拷贝PUT /domain//sslizeContent-Type: application/jsonAuthorization: QBox { 'certid': , 'forceHttps': , 'http2Enable': }
参数解释
| 参数 | 类型 | 含义 |
|---|---|---|
| CertID | string | 证书id，从上传或者获取证书列表里拿到证书id |
| ForceHttps | bool | 是否强制https跳转 |
| Http2Enable | bool | http2功能是否启用，false为关闭，true为开启 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400331 | 非法参数 |
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400008 | 无此bucket |
| 400392 | 非法的域名cname |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400401 | 无此证书 |
| 400324 | https证书解码失败 |
| 400325 | https证书解析失败 |
| 400321 | https证书还未生效 |
| 400329 | https证书过期 |
| 400326 | https证书与域名不匹配 |
| 400327 | 解析https证书密钥失败 |
| 400328 | https证书与密钥不匹配 |
| 400323 | 验证https证书链失败 |
| 400550 | 非法的证书id |
| 500219 | 查询证书内部错误 |
| 500005 | 数据查询内部出错 |
HTTPS降级为HTTP
拷贝HTTPS降级为HTTP
请求包
拷贝PUT /domain//unsslizeContent-Type: application/jsonAuthorization: QBox
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400331 | 非法参数 |
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400093 | 非法的域名类型 |
| 400008 | 无此bucket |
| 400392 | 非法的域名cname |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400923 | 域名已冻结 |
| 400066 | 域名状态为失败 |
| 401001 | 域名不允许操作 |
| 500004 | 更新数据内部出错 |
| 500005 | 数据查询内部出错 |
修改证书
拷贝修改证书
请求包
拷贝PUT /domain//httpsconfContent-Type: application/jsonAuthorization: QBox { 'certId': , 'forceHttps': , 'http2Enable': }
参数解释
| 参数 | 类型 | 含义 |
|---|---|---|
| CertID | string | 证书id，从上传或者获取证书列表里拿到证书id |
| ForceHttps | bool | 是否强制https跳转 |
| Http2Enable | bool | http2功能是否启用，false为关闭，true为开启 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400331 | 非法参数 |
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400008 | 无此bucket |
| 400392 | 非法的域名cname |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400401 | 无此证书 |
| 400324 | https证书解码失败 |
| 400325 | https证书解析失败 |
| 400321 | https证书还未生效 |
| 400329 | https证书过期 |
| 400326 | https证书与域名不匹配 |
| 400327 | 解析https证书密钥失败 |
| 400328 | https证书与密钥不匹配 |
| 400323 | 验证https证书链失败 |
| 500219 | 查询证书内部错误 |
| 500005 | 数据查询内部出错 |
修改referer防盗链
拷贝用户修改普通域名及泛域名referer防盗链接口
请求包
拷贝PUT /domain//refererContent-Type: application/jsonAuthorization: QBox { Referer}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Referer | object | 是 | Referer结构请参考 referer防盗链 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400008 | 无此bucket |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 400923 | 域名已冻结 |
| 500930 | 删除中的域名 |
| 400060 | 未知的referer防盗链类型 |
| 400061 | 未知的referer防盗链参数 |
| 500005 | 数据查询内部出错 |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/referer HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'refererType': 'white','refererValues': ['*.qiniu.com','qiniu.com'],'nullReferer': true}修改ip黑白名单
拷贝用户修改普通域名及泛域名ip黑白名单接口
请求包
拷贝PUT /domain//ipaclContent-Type: application/jsonAuthorization: QBox { IPACL}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| IPACL | object | 是 | IPACL结构请参考 ip黑白名单 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400008 | 无此bucket |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 400923 | 域名已冻结 |
| 500930 | 删除中的域名 |
| 400074 | 非法的ip黑白名单类型 |
| 400075 | 非法的ip黑白名单参数 |
| 500005 | 数据查询内部出错 |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/ipacl HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'ipACLType': 'black','ipACLValues': ['115.223.202.9']}修改时间戳防盗链
拷贝用户修改普通域名及泛域名时间戳防盗链接口
请求包
拷贝PUT /domain//timeaclContent-Type: application/jsonAuthorization: QBox { TimeACL}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| TimeACL | object | 是 | TimeACL结构请参考 时间戳防盗链 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400008 | 无此bucket |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 400923 | 域名已冻结 |
| 500930 | 删除中的域名 |
| 400204 | 开启时间戳防盗链时，必须两组key |
| 400318 | 修改时间戳防盗链未带key |
| 400308 | 不能同时修改时间戳防盗链上所有的key |
| 400031 | 非法的url |
| 500005 | 数据查询内部出错 |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/timeacl HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'enable': true,'timeACLKeys': ['abcdefghijklmnopqrstuvwxyz','zyxwvutsrqponmlkjihgfedcba'],'checkUrl': 'http://xxx.yyy.com/DIR1/dir2/vodfile.mp4?v=1.1&sign=19eb212771e87cc3d478b9f32d6c7bf9&t=55bb9b80'}修改回源鉴权
拷贝用户修改普通域名及泛域名回源鉴权接口
请求包
拷贝PUT /domain//bsauthContent-Type: application/jsonAuthorization: QBox { Bsauth}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Bsauth | object | 是 | 请参考 回源鉴权 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400200 | 未知的bucket |
| 400008 | 无此bucket |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 400923 | 域名已冻结 |
| 500930 | 删除中的域名 |
| 400520 | 不能同时设置时间戳防盗链和回源鉴权 |
| 400521 | 非法的回源鉴权地址 |
| 400522 | 非法的回源鉴权http方法 |
| 400523 | 非法的回源鉴权http code |
| 400524 | 非法的回源鉴权超时时间 |
| 400525 | 非法的回源鉴权url参数 |
| 500005 | 数据查询内部出错 |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/bsauth HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'enable': true,'isQiniuPrivate': false,'path': [],'method': 'POST','parameters': ['e','token'],'timeLimit': 5000,'userAuthUrl': 'http://auth.testqbox.net','strict': true,'successStatusCode': 200,'failureStatusCode': 401}修改特殊配置
拷贝用户修改普通域名及泛域名特殊配置接口
请求包
拷贝PUT /domain//externalContent-Type: application/jsonAuthorization: QBox { External}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| External | object | 是 | 结构请参考 特殊配置 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400200 | 未知的bucket |
| 400008 | 域名绑定的bucket已删除 |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 400923 | 域名已冻结 |
| 500930 | 删除中的域名 |
| 404911 | 非法的路径 |
| 404912 | 非法的正则表达式 |
| 500005 | 数据查询内部出错 |
请求示例
拷贝PUT /domain/testqiniu.qbox.net/external HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'enableFop': true,'imageSlim': {'enableImageSlim': true,'prefixImageSlims': ['/abc','/def']}}修改响应头
拷贝修改CDN返回给用户的响应头
请求包
拷贝PUT /domain//respheaderContent-Type: application/jsonAuthorization: QBox {responseHeaderControls: [{op: ,key: ,value: }...]}
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Name | string | 是 | 域名 |
| op | string | 是 | 对响应头的进行操作的类型，可选'set'、“del”，目前不支持'add' |
| key | string | 是 | 匹配响应头的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,Access-Control-Allow-Credentials。 |
| value | string | 是 | 响应头的value，在op为'set'时有效 |
返回包
拷贝{ }错误码
| 错误码 | 含义 |
|---|---|
| 404001 | 无此域名 |
| 400001 | 未知的域名 |
| 400064 | 无权处理该域名 |
| 400008 | 无此bucket |
| 400013 | 重复操作 |
| 400030 | 正在处理中 |
| 400066 | 域名状态为失败 |
| 400998 | 域名已下线 |
| 400923 | 域名已冻结 |
| 400084 | 无效的响应头key |
| 400085 | 无效的响应头操作请求 |
| 400086 | 重复的响应头key |
| 500930 | 删除中的域名 |
| 500005 | 数据查询内部出错 |
创建新的域名标签
拷贝在账户下添加新的域名标签
请求包
拷贝POST /domain/tag HTTP/1.1Content-Type: application/jsonAuthorization: QBox{ 'tag': ,'tagKey': ,'tagValue': , 'product': }
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Tag | string | 否 | 域名标签（废弃） |
| TagKey | string | 是 | 域名标签Key |
| TagValue | string | 是 | 域名标签Value |
| Product | string | 是 | 产品类型: cdn(静态加速)/dcdn(全站加速) |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400331 | 非法参数 |
| 400925 | 账号域名标签数量达到上限 |
| 400927 | 域名标签已存在 |
| 500004 | 更新数据内部出错 |
| 500005 | 数据查询内部出错 |
请求示例
拷贝POST /domain/tag HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'tagKey': '图片','tagValue': '高清','product': 'cdn'}设置域名标签
拷贝选取账户下定义好的标签，为域名配置标签列表
请求包
拷贝PUT /domain//tags HTTP/1.1Content-Type: application/jsonAuthorization: QBox { 'kvTagList': }
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| TagList | []string | 否 | 标签列表（废弃） |
| kvTagList | []Object | 是 | Key-Value格式标签列表 |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400331 | 非法参数 |
| 404001 | 无此域名 |
| 400064 | 无权处理该域名 |
| 400926 | 单个域名标签数量达到上限 |
| 500004 | 更新数据内部出错 |
| 500005 | 数据查询内部出错 |
请求示例
拷贝PUT /domain//tags HTTP/1.1Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=Content-Type: application/jsonHost: api.qiniu.com{'kvTagList': [{'key':'图片','value':'高清'}]}
获取所有域名标签
拷贝获取账户下定义的域名标签
请求包
拷贝GET /domain/all/tags?product=Content-Type: application/x-www-form-urlencodedAuthorization: QBox
参数解释
| 参数 | 类型 | 必填 | 含义 |
|---|---|---|---|
| Product | string | 是 | 产品类型: cdn(静态加速)/dcdn(全站加速) |
返回包
拷贝{}错误码
| 错误码 | 含义 |
|---|---|
| 400331 | 非法参数 |
| 500005 | 数据查询内部出错 |
