CDNCA

开放接口

/v1/admin/probe-dnspup

9 个接口

← 全部分组 · 第一次调用？先看教程：认证、权限、请求与响应、常见失败

方法路径摘要认证
POST/v1/admin/probe-dnspup/diagnoses按需 MTR 排障（最多 2 个检测点，计入「排障」用途额度）登录会话
GET/v1/admin/probe-dnspup/diagnoses/{id}读取排障结果（运行中带 Retry-After）登录会话
GET/v1/admin/probe-dnspup/edge-subjects最近一天有拨测结果的第三方 CDN 候选主机登录会话
GET/v1/admin/probe-dnspup/matrix节点或第三方 CDN 候选的「地区 × 运营商」矩阵与历史曲线登录会话
GET/v1/admin/probe-dnspup/node-monitoring/overrides按节点或线路组覆盖的拨测类型与选点登录会话
PUT/v1/admin/probe-dnspup/node-monitoring/overrides新建或替换一个节点（node_id）或线路组（tenant_scope_id + line_group_id）的覆盖登录会话
DELETE/v1/admin/probe-dnspup/node-monitoring/overrides/{id}删除覆盖（恢复继承）登录会话
GET/v1/admin/probe-dnspup/purposes按用途的拨测开关、月上限、频率、本月用量、预计月用量与降频状态登录会话
PUT/v1/admin/probe-dnspup/purposes修改用途的开关、月上限与最小间隔（可用性类用途不能关闭）登录会话

契约文件：api/control-probe-dnspup.openapi.yaml

接口详情

POST /v1/admin/probe-dnspup/diagnoses

按需 MTR 排障（最多 2 个检测点，计入「排障」用途额度）

operationId
createProbeDNSPupDiagnosis
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

参数

createProbeDNSPupDiagnosis 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—

请求体

application/json · 必填：是

createProbeDNSPupDiagnosis 请求体
名称类型必填说明
targetstring是public IP or domain
node_idstring(uuid)否—
checkpointsarray<string>是—

响应

createProbeDNSPupDiagnosis 响应
状态码说明
202Started

字段：id: string(uuid) status: string: pending / completed / failed type: string target: string error_code?: string created_at: string(date-time) traces?: any results: array<object>

401Error envelope
403Error envelope
409Error envelope
422Error envelope
429Error envelope
503Error envelope

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。
  • 429 被限速：等待后再试，降低并发。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

GET /v1/admin/probe-dnspup/diagnoses/{id}

读取排障结果（运行中带 Retry-After）

operationId
getProbeDNSPupDiagnosis
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

参数

getProbeDNSPupDiagnosis 参数
名称位置类型必填说明
idpathstring(uuid)是—

响应

getProbeDNSPupDiagnosis 响应
状态码说明
200Diagnosis

字段：id: string(uuid) status: string: pending / completed / failed type: string target: string error_code?: string created_at: string(date-time) traces?: any results: array<object>

401Error envelope
403Error envelope
404Error envelope

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。

↑ 回到列表

GET /v1/admin/probe-dnspup/edge-subjects

最近一天有拨测结果的第三方 CDN 候选主机

operationId
listProbeDNSPupEdgeSubjects
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

响应

listProbeDNSPupEdgeSubjects 响应
状态码说明
200Hosts

字段：items: array<string>

401Error envelope
403Error envelope

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

GET /v1/admin/probe-dnspup/matrix

节点或第三方 CDN 候选的「地区 × 运营商」矩阵与历史曲线

operationId
getProbeDNSPupMatrix
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

参数

getProbeDNSPupMatrix 参数
名称位置类型必填说明
subjectquerystring: node / edge是—
idquerystring是node id, or the candidate host
windowquerystring: 1h / 6h / 24h / 7d否—

响应

getProbeDNSPupMatrix 响应
状态码说明
200Matrix

字段：subject: string id: string window: string cells: array<object> series: array<object>

401Error envelope
403Error envelope
422Error envelope

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

GET /v1/admin/probe-dnspup/node-monitoring/overrides

按节点或线路组覆盖的拨测类型与选点

operationId
listProbeDNSPupNodeOverrides
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

响应

listProbeDNSPupNodeOverrides 响应
状态码说明
200Overrides

字段：items: array<Override>

401Error envelope
403Error envelope
503Error envelope

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

PUT /v1/admin/probe-dnspup/node-monitoring/overrides

新建或替换一个节点（node_id）或线路组（tenant_scope_id + line_group_id）的覆盖

operationId
putProbeDNSPupNodeOverride
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

参数

putProbeDNSPupNodeOverride 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—

请求体

application/json · 必填：是

putProbeDNSPupNodeOverride 请求体
名称类型必填说明
node_idstring(uuid)否—
tenant_scope_idstring(uuid)否—
line_group_idstring(uuid)否—
probe_typestring: tcping / ping / http否—
selectionSelection否—

响应

putProbeDNSPupNodeOverride 响应
状态码说明
200Saved

字段：id: string(uuid) subject_kind: string: node / line_group node_id?: string(uuid) tenant_scope_id?: string(uuid) line_group_id?: string(uuid) subject_name: string subject_display_id?: integer probe_type?: string: tcping / ping / http / null | null: tcping / ping / http / null selection?: Selection | null revision: integer

400Error envelope
401Error envelope
403Error envelope
409Error envelope
422Error envelope

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

DELETE /v1/admin/probe-dnspup/node-monitoring/overrides/{id}

删除覆盖（恢复继承）

operationId
deleteProbeDNSPupNodeOverride
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

参数

deleteProbeDNSPupNodeOverride 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—
idpathstring(uuid)是—

响应

deleteProbeDNSPupNodeOverride 响应
状态码说明
204Deleted
401Error envelope
403Error envelope
404Error envelope
409Error envelope

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

GET /v1/admin/probe-dnspup/purposes

按用途的拨测开关、月上限、频率、本月用量、预计月用量与降频状态

operationId
getProbeDNSPupPurposes
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

响应

getProbeDNSPupPurposes 响应
状态码说明
200Purposes

字段：monthly_limit: integer monthly_used: integer projected_monthly: integer purposes: array<object>

401Error envelope
403Error envelope

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

PUT /v1/admin/probe-dnspup/purposes

修改用途的开关、月上限与最小间隔（可用性类用途不能关闭）

operationId
putProbeDNSPupPurposes
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：system.probe_dnspup.manage

参数

putProbeDNSPupPurposes 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—

请求体

application/json · 必填：是

putProbeDNSPupPurposes 请求体
名称类型必填说明
purposesarray<object>是—

响应

putProbeDNSPupPurposes 响应
状态码说明
200Saved

字段：monthly_limit: integer monthly_used: integer projected_monthly: integer purposes: array<object>

400Error envelope
401Error envelope
403Error envelope
409Error envelope
422Error envelope

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表