全站加速

    • 全站加速 > API 文档 > 域名管理

    域名管理

    最近更新时间: 2026-09-03 11:18:41

    创建域名

    用户创建全站加速普通及泛域名接口

    请求包

    POST /domain/<Name> HTTP/1.1
Content-Type: application/json
Authorization: QBox <AccessToken>
{
	// 基本配置
	"type": <Type>,
	"platform": <Platform>,
	"geoCover": <GeoCover>,
	"protocol": <Protocol>,
        "ipTypes": <IpTypes>,
	// 回源配置
	"source": <Source>,
	// 缓存配置
	"cache": <Cache>,
	// 备案号
	"registerNo": <RegisterNo>
}

    参数解释

    基本参数

    参数类型必填含义
    Namestring是域名, 如果是泛域名，必须以点号 . 开头
    Typestring是域名类型: `normal`(普通域名)/`wildcard`(泛域名)
    Platformstring是平台类型: 固定值 `dynamic`(动态加速)
    GeoCoverstring是地域: `china`/`foreign`/`global`
    Protocolstring是协议: `http`/`https`
    Source请参考 回源配置是回源参数
    Cache请参考 缓存策略备注：平台是动态加速是“否”，其他平台为“是”缓存参数
    RegisterNostring否当创建域名返回`code: 500230` 或者返回的内容提示为`备案查询服务已关闭`，需要API调用者在本参数输入域名的备案号
    IpTypesuint否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无此证书
    400324https证书解码失败
    400325https证书解析失败
    400321https证书还未生效
    400329https证书过期
    400326https证书与域名不匹配
    400327解析https证书密钥失败
    400328https证书与密钥不匹配
    400323验证https证书链失败
    400549只有https域名才能使用强制https跳转
    400621泛域名及其子域名不能使用私有bucket
    400005未知的协议
    400332未知的回源协议
    400932域名所有权验证失败
    500219查询证书内部错误
    500005数据查询内部出错
    500230备案查询服务已关闭
    500000未知内部错误

    请求示例

    POST /domain/testqiniu.qbox.net HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: 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
  }

    上线域名

    用户上线普通及泛域名接口

    请求包

    POST /domain/<Name>/online
Content-Type: application/json
Authorization: QBox <AccessToken>

    错误码

    错误码含义
    404001无此域名
    400001未知的域名
    400064无权处理该域名
    400093非法的域名类型
    400013重复操作
    400030正在处理中
    400066域名状态为失败
    400018非法的cname
    400397cname和其他域名冲突
    500004更新数据内部出错
    500923域名已冻结
    500005数据查询内部出错
    500235该域名未绑定证书

    下线域名

    用户下线普通及泛域名接口

    请求包

    POST /domain/<Name>/offline
Content-Type: application/json
Authorization: QBox <AccessToken>

    错误码

    错误码含义
    404001无此域名
    400001未知的域名
    400064无权处理该域名
    400093非法的域名类型
    400013重复操作
    400030正在处理中
    400066域名状态为失败
    400018非法的cname
    400397cname和其他域名冲突
    400923域名已冻结
    500005数据查询内部出错

    删除域名

    用户删除普通及泛域名接口

    请求包

    DELETE /domain/<Name>
Content-Type: application/json
Authorization: QBox <AccessToken>

    错误码

    错误码含义
    404001无此域名
    400001未知的域名
    400064无权处理该域名
    400013重复操作
    400030正在处理中
    400317非已下线的域名
    400066域名状态为失败
    400515该泛域名还含有活跃的子域名
    500005数据查询内部出错

    获取域名信息

    用户获取域名信息接口，所有域名适用

    请求包

    GET /domain/<Name>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>

    返回包

    {
	"name": <Name>,
	"type": <Type>,
	"cname": <CName>,
	"testURLPath": <TestURLPath>,
	"platform": <Platform>,
	"geoCover": <GeoCover>,
	"protocol": <Protocol>,
        "ipTypes": <IpTypes>,
        "tagList": <TagList>,
        "kvTagList": <KvTagList>
	"source": <Source>,
	"cache": <Cache>,
	"referer": <Referer>,
	"ipACL": <IPACL>,
	"operationType": <OperationType>,
	"operatingState": <OperatingState>,
	"operatingStateDesc": <OperatingStateDesc>,
	"createAt": <CreateAt>,
	"modifyAt": <ModifyAt>,
	"pareDomain": <PareDomain>,
	"https": <Https>,
}

    参数解释

    基本参数 请参考

    参数类型含义
    CNamestring创建域名成功后七牛生成的域名，用户需要把 `Name` cname 到这个域名
    RefererobjectReferer结构请参考 referer防盗链
    IPACLobjectIPACL结构请参考 ip黑白名单
    SourceobjectSource结构请参考 回源配置
    CacheobjectCache结构请参考 缓存策略
    OperationTypestring域名最近一次操作类型: `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`(删除回源鉴权)
    OperatingStatestring域名最近一次的操作状态: `processing`/`success`/`failed`/`frozen`/`offlined`
    OperatingStateDescstring域名最近一次的操作状态的描述
    CreateAtstring域名创建时间，格式:RFC3339
    ModifyAtstring域名最后一次修改时间，格式:RFC3339
    PareDomainstring父域名,属于泛子域名字段
    HttpsObjectHttps结构请参考 HTTPS
    IpTypesuintIP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。
    TagList[]string域名的标签列表（废弃）
    kvTagList[]Object域名的Key-Value标签列表

    错误码

    错误码含义
    404001无此域名
    400001未知的域名
    400014无权获取该域名
    500005数据查询内部出错

    获取域名列表

    用户获取域名列表接口，所有域名适用

    请求包

    GET /domain?product=<Product>&types=<Types>&certId=<CertId>&sourceTypes=<SourceTypes>&sourceQiniuBucket=<SourceQiniuBucket>&sourceIp=<SourceIp>&marker=<Marker>&limit=<Limit>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>

    参数解释

    参数类型含义
    Productstring全站加速固定传参 "dcdn"。
    Types[]string域名类型，可选normal（普通域名）、wildcard（泛域名）、pan（泛子域名）、test（测试域名）中的一个或多个，不填默认查询全部域名。
    CertIdstring证书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。
    SourceQiniuBucketstring七牛存储空间名称，不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=qiniuBucket&sourceQiniuBucket=test。
    SourceIpstring回源IP, 不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=ip&sourceIp=1.1.1.1。
    Markerstring用于标示从哪个位置开始获取域名列表，不填或空表示从头开始。
    Limitint返回的最大域名个数。1~1000, 不填默认为 10

    返回包

    {
	"marker": <Marker>,
	"domains": [
		{
			"name": <Name>,
			"type": <Type>,
			"cname": <CName>,
			"testURLPath": <TestURLPath>,
			"platform": <Platform>,
			"geoCover": <GeoCover>,
			"protocol": <Protocol>,
			"operatingState": <OperatingState>,
			"operatingStateDesc": <OperatingStateDesc>,
			"createAt": <CreateAt>,
			"modifyAt": <ModifyAt>,
		},
		...
	]
}

    参数解释

    基本参数 请参考

    参数类型含义
    Markerstring用于标示下一次从哪个位置开始获取域名列表
    CNamestring创建域名成功后七牛生成的域名，用户需要把 `Name` cname 到这个域名
    TestURLPathstring域名的测试资源，需要保证这个资源是可访问的
    IpTypesuintIP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。
    TagList[]string域名的标签列表 （废弃）
    KvTagList[]Object域名的Key-Value标签列表
    OperatingStatestring域名最近一次的操作状态: `processing`/`success`/`failed`/`frozen`/`offlined`
    CreateAtstring域名创建时间，格式:RFC3339
    ModifyAtstring域名最后一次修改时间，格式:RFC3339

    错误码

    错误码含义
    400021非法的参数marker
    500005数据查询内部出错
    以上内容是否对您有帮助？