版本 2.4.8 · 最新
DNS 服务商 dns-providers
仅管理员。保存 DNS 服务商账号(阿里云、Cloudflare 等);保存前在线校验凭据,凭据只回末 4 位提示。
点击任一接口,右侧显示对应的调用示例。
DNS 与接入鉴权: 仅管理员6 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/dns-providers列出DNS 服务商
鉴权: 仅管理员
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
type | string | 只列该服务商类型(如 aliyun)。 |
POST
/api/v2/dns-providers创建DNS 服务商
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
auth_id | string | 凭据 ID(阿里云 AccessKey ID、DNSPod Token ID 或腾讯云 SecretId、Cloudflare 邮箱;Cloudflare API Token 时为空)。 |
auth_key | string | 凭据(AccessKey Secret / Token / SecretKey / API Key);创建必填,修改时不给或为空 = 沿用原值。库内加密保存。 |
expected_updated_at | string | 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查;创建时忽略。 |
gateway | string | 自建 API 网关地址(只有 dnsdun 用)。 |
name必填 | string | 名称 |
remark | string | 备注 |
ttl | integer | 本账号下记录的默认 TTL(秒)。 |
type必填 | string | 服务商类型:aliyun、cloudflare、dnspod_cn、dnspod_com;dns_la、dnsdotcom、dnsdun。 |
PUT
/api/v2/dns-providers/{id}修改DNS 服务商
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
auth_id | string | 凭据 ID(阿里云 AccessKey ID、DNSPod Token ID 或腾讯云 SecretId、Cloudflare 邮箱;Cloudflare API Token 时为空)。 |
auth_key | string | 凭据(AccessKey Secret / Token / SecretKey / API Key);创建必填,修改时不给或为空 = 沿用原值。库内加密保存。 |
expected_updated_at | string | 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查;创建时忽略。 |
gateway | string | 自建 API 网关地址(只有 dnsdun 用)。 |
name必填 | string | 名称 |
remark | string | 备注 |
ttl | integer | 本账号下记录的默认 TTL(秒)。 |
type必填 | string | 服务商类型:aliyun、cloudflare、dnspod_cn、dnspod_com;dns_la、dnsdotcom、dnsdun。 |
DNS 服务商对象
| 字段 | 类型 | 说明 |
|---|---|---|
auth_id | string | 凭据 ID(阿里云 AccessKey ID、DNSPod Token ID 或腾讯云 SecretId、Cloudflare 邮箱;Cloudflare API Token 时为空)。 |
auth_key | string | 凭据(AccessKey Secret / Token / SecretKey / API Key);创建必填,修改时不给或为空 = 沿用原值。库内加密保存。 |
auth_key_hint | string | 凭据末 4 位(前面以 * 补齐),不回原文。 |
auth_unreadable | boolean | 库里存有凭据但解不开(主控凭据加密钥不符或数据被改)时为 true,此时 auth_key_hint 为空;没配过凭据为 false(auth_key_hint 也为空)。面板据此区分「凭据解不开」与「未配置凭据」。 |
created_at | string | 创建时间 |
degrade_count | integer | 本账号下根域当前的线路降级行数(line_degrades:有域名不能原样下发某条线路);没有为 0。DNS 设置页左栏「线路降级 N 条」读它。 |
domain_count | integer | 托管在本账号下的接入根域个数(含已停用、换出中的);没有为 0。 |
domains | integer | 本次拉取的域名个数。 |
expected_updated_at | string | 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查;创建时忽略。 |
failed | integer | 拉取失败的域名个数。 |
gateway | string | 自建 API 网关地址(只有 dnsdun 用)。 |
id | integer | 记录 ID |
line_cap | DnsLineCap | 账号的线路能力(DNS 设置页账号头标签与悬停)。 |
lines | integer | 成功拉到的线路条数合计。 |
name | string | 名称 |
ok | integer | 拉取成功的域名个数。 |
remark | string | 备注 |
ttl | integer | 本账号下记录的默认 TTL(秒)。 |
type | string | 服务商类型:aliyun、cloudflare、dnspod_cn、dnspod_com;dns_la、dnsdotcom、dnsdun。 |
updated_at | string | 更新时间 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}