德胜云开发者文档域名管理
域名新增、配置与管理相关接口说明。
说明
鉴权
参考 签名&鉴权
接口响应
参考 接口说明
QPS
单用户调用频率限制：20 次/秒。
API
域名创建
POST /domain/v1/create
参数说明
| 参数名 | 类型 | 必传 | 说明 |
|---|---|---|---|
| domain | string | 是 | 接入域名 |
| scenarioType | string | 是 | web,download,video |
| sources | []Source | 是 | 源站配置 |
| scope | string | 否 | domestic: 国内，overseas: 海外，global: 全球不传，默认为domestic |
Source
| 参数名 | 类型 | 必传 | 说明 |
|---|---|---|---|
| origin | string | 是 | 回源地址，IP 或 域名 |
| type | string | 是 | ip：IP源站，domain：域名源站 |
| port | string | 是 | 端口，比如 80 |
| weight | string | 是 | 针对本源站的回源权重，1-100 |
| role | string | 是 | master: 主源站, slave：备源站回源先主后备，同一个role之间按weight分配 |
| protocol | string | 是 | 回源协议：http,https |
| host | string | 否 | 回源host，默认为接入域名 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| reqId | string | 请求唯一id |
域名查询
POST /domain/v1/one
参数说明
| 参数名 | 类型 | 必传 | 说明 |
|---|---|---|---|
| domain | string | 是 | 请求的域名 |
返回值
返回值，可以忽略 必传字段
DomainInfoResp
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| cname | string | 是 | CNAME记录值 |
| scenarioType | *string | 否 | 场景类型：web、download、video |
| sources | []Source | 否 | 回源配置 |
| caches | []Cache | 否 | 缓存配置 |
| https | Https | 否 | HTTPS配置 |
| referer | Referer | 否 | Referer防盗链配置 |
| ipFilter | IPFilter | 否 | IP黑白名单配置 |
| uaFilter | UAFilter | 否 | UA黑白名单配置 |
| scope | string | 否 | 区域范围：domestic(国内)、overseas(海外)、global(全球)，默认domestic |
| createAt | int64 | 是 | 创建时间(秒级时间戳) |
| updateAt | int64 | 是 | 更新时间(秒级时间戳) |
| remark | *string | 否 | 备注信息 |
Source
见上面的定义
Cache
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| ttl | int64 | 是 | 缓存过期时间，单位s，0为不缓存 |
| type | string | 是 | 缓存类型：all（所有文件生效）、file（指定文件后缀生效）、directory（指定路径生效）、follow（遵循源站） |
| args | string | 是 | 参数控制：ignoreall（忽略全部参数）、keepall（保留全部参数） |
| priority | int | 是 | 优先级，范围1-100，默认1，数字越大优先级越高 |
| rule | string | 是 | 缓存具体规则，逗号分隔与type的映射关系type为all对应rule为type为file对应后缀列表，rule为 .jpg,.txt,.csv 等type为directory对应路径列表，rule为/abc/,/ebd/dst/等type为follow对应rule为 |
Https
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| status | string | 是 | 开启HTTPS：on/off，默认on |
| certId | string | 当status为on时必传 | 证书 ID，status为on时必传 |
| http2 | string | 否 | 是否开启HTTP2：on/off，默认off |
| forceHttps | string | 否 | 是否强制HTTPS访问：on/off，默认off |
| tls | array | 否 | TLS 版本，可选值：tsl.v1/tsl.v2/tsl.v3/tsl.v4 |
Referer
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| allowEmpty | bool | 否 | 是否容许空referer，默认禁止false |
| type | string | 是 | referer类型：black（黑名单）/white（白名单） |
| values | []string | 是 | referer值。不要写协议头比如 http://支持域名前使用通配符*：*.example.com可用于指代所有example.com下的多级子域名（不包含example.com） |
IPFilter
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| type | string | 是 | IP过滤类型：black（黑名单）/white（白名单） |
| values | []string | 是 | IP地址或网段列表，格式示例：128.0.0.3,127.0.0.1/24 |
UAFilter
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| type | string | 是 | UA过滤类型：black（黑名单）/white（白名单） |
| values | []string | 是 | User-Agent值列表，用于过滤请求 |
域名列表
POST /domain/v1/list
参数说明
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domains | string | 否 | 域名列表，多个域名用逗号分隔 |
| page | int64 | 是 | 分页页码 |
| size | int64 | 是 | 每页数量 |
返回值
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domainInfos | []DomainInfoResp | 是 | 域名信息列表，具体结构参考DomainInfoResp里的定义 |
| count | int64 | 是 | 域名总数 |
DomainInfoResp
定义见 域名查询接口
配置源站
PUT /domain/v1/sources
参数说明
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| sources | []Source | 是 | 源站配置列表，参考 域名创建 里的定义回源配置必须传递 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| reqId | string | 请求唯一id |
配置缓存
PUT /domain/v1/caches
参数说明
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| caches | []Cache | 否 | 缓存配置列表，具体结构参考域名查询 里的定义不传递为删除缓存配置 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| reqId | string | 请求唯一id |
配置referer
PUT /domain/v1/referer
参数说明
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| referer | Referer | 否 | referer防盗链配置不传递代表删除具体结构参考 域名查询 里的定义 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| reqId | string | 请求唯一id |
配置IP黑白名单
PUT /domain/v1/ipfilter
参数说明
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| ipFilter | IPFilter | 否 | IP黑白名单配置不传递代表删除具体结构参考 域名查询 里的定义 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| reqId | string | 请求唯一id |
配置UA黑白名单
PUT /domain/v1/uafilter
参数说明
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| uaFilter | UAFilter | 否 | UA黑白名单配置不传递代表删除具体结构参考 域名查询 里的定义 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| reqId | string | 请求唯一id |
配置HTTPS
PUT /domain/v1/https
参数说明
| 参数名 | 类型 | 必传(返回值时忽略) | 说明 |
|---|---|---|---|
| domain | string | 是 | 域名 |
| https | Https | 是 | HTTPS 配置具体结构参考 域名查询 里的定义 |