CDNGOD

DEVELOPER DOCUMENTATION

让接入有据可查。

接口目录与类型均来自同一份 OpenAPI 契约。程序请求使用签名凭证；控制台使用可撤销的浏览器会话。

开始接入

  1. 注册并验证邮箱，完成企业实名，确认团队角色。
  2. 在控制台创建所需权限范围的 API 凭证，妥善保存仅展示一次的 Secret Key。
  3. 在已授权域名上完成所有权验证及接入配置，按接口契约提交请求。
  4. 保存 operation_id 和 request_id，查询实际部署或业务结果。

API 凭证不能操作充值、退款、实名审批或平台管理。阅读完整签名规则 →

先理解响应，再处理重试

HTTP 202 表示操作已受理；最终部署、支付或退款结果应读取对应资源。超时、断连及缺失数据都可能需要继续查询，不应直接显示为失败、成功或零。

错误响应使用 code、message、request_id。排障时提交请求编号，避免附带密码、Secret Key、支付凭据或证书私钥。

{
  "code": "not_found",
  "message": "Resource not found",
  "request_id": "public-synthetic-request-id"
}

接口目录

目录由发布时的 OpenAPI 契约生成。接口是否可用还取决于当前环境、功能开关及账户权限。

当前分类匹配 38 项。金额与大整数均按契约中的字符串格式处理。

GET /openapi/v1/cache/quota

openapiGetCacheQuota

操作标识：openapiGetCacheQuota · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 429 / 503

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • kind（query，必填）
GET /openapi/v1/cache/tasks

openapiListCacheTasks

操作标识：openapiListCacheTasks · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 429 / 503

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • kind（query，可选）
  • cursor（query，可选）
  • limit（query，可选）
POST /openapi/v1/cache/tasks

openapiCreateCacheTask

操作标识：openapiCreateCacheTask · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 413 / 429 / 503

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • Idempotency-Key（header，必填）
GET /openapi/v1/cache/tasks/{task_id}

openapiGetCacheTask

操作标识：openapiGetCacheTask · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 429 / 503

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • task_id（path，必填）
GET /openapi/v1/certificates

List current tenant certificate metadata

操作标识：openAPIListCertificates · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 500

  • cursor（query，可选）
  • limit（query，可选）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/certificates

Validate and encrypt a manual certificate locally

操作标识：openAPIUploadCertificate · 响应状态：201 / 400 / 401 / 403 / 404 / 409 / 422 / 500

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • Idempotency-Key（header，必填）：Keep the same key and exact body when the response is unknown.
DELETE /openapi/v1/certificates/{id}

Queue deletion only when no binding or unresolved operation references the certificate

操作标识：openAPIDeleteCertificate · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 500

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • Idempotency-Key（header，必填）：Keep the same key and exact body when the response is unknown.
GET /openapi/v1/certificates/{id}

Read certificate metadata without private material

操作标识：openAPIGetCertificate · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 500

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/certificates/{id}/bindings

List desired and active bindings referencing the certificate

操作标识：openAPIListCertificateBindings · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 500

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/certificates/bindings

Queue versioned certificate upload and HTTPS settings

操作标识：openAPIBindCertificate · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 422 / 500

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • Idempotency-Key（header，必填）：Keep the same key and exact body when the response is unknown.
GET /openapi/v1/certificates/bindings/{domain_id}

Read current tenant domain binding state

操作标识：openAPIGetCertificateBinding · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 500

  • domain_id（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/certificates/bindings/unbind

Queue HTTPS unbinding while retaining the active certificate until confirmation

操作标识：openAPIUnbindCertificate · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 500

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • Idempotency-Key（header，必填）：Keep the same key and exact body when the response is unknown.
POST /openapi/v1/certificates/preview

Preview certificate metadata without storing or uploading it

操作标识：openAPIPreviewCertificate · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 500

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/domain-groups

List current tenant group names

操作标识：openAPIListGroups · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 503

  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • cursor（query，可选）
  • limit（query，可选）
POST /openapi/v1/domain-groups

Create a tenant-prefixed upstream group asynchronously

操作标识：openAPICreateGroup · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 503

  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
DELETE /openapi/v1/domain-groups/{group_id}

Remove group associations while preserving all domains

操作标识：openAPIDeleteGroup · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 503

  • group_id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
PATCH /openapi/v1/domain-groups/{group_id}

Rename a tenant group asynchronously

操作标识：openAPIUpdateGroup · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 503

  • group_id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/domain-groups/{group_id}/domains

Read confirmed tenant group members with domains:read

操作标识：openAPIListGroupDomains · 响应状态：200 / 400 / 401 / 403 / 404 / 503

  • group_id（path，必填）
  • cursor（query，可选）
  • limit（query，可选）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domain-groups/{group_id}/domains

Add or remove at most ten current tenant domains

操作标识：openAPIAssignGroup · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 503

  • group_id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/domains

List current tenant domain states

操作标识：listOpenAPIDomains · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 503

  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • cursor（query，可选）
  • limit（query，可选）
POST /openapi/v1/domains

Verify ownership and admit durable domain creation

操作标识：createOpenAPIDomain · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • Idempotency-Key（header，必填）
GET /openapi/v1/domains/{id}

Read separate creation, deployment, DNS and user-resolution state

操作标识：getOpenAPIDomain · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 503

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/domains/{id}/config

Read requested and effective configuration versions

操作标识：machineGetDomainConfig · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domains/{id}/config

Submit an encrypted, durable configuration version

操作标识：machineSubmitDomainConfig · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domains/{id}/config/rollback

Create a new requested version from a historical observed-effective configuration

操作标识：machineRollbackDomainConfig · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/domains/{id}/config/versions

List tenant-bound configuration versions newest first

操作标识：machineListDomainConfigVersions · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
  • cursor（query，可选）
  • limit（query，可选）
GET /openapi/v1/domains/{id}/config/versions/{version}

Read a historical request and its redacted observed-effective result

操作标识：machineGetDomainConfigVersion · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • id（path，必填）
  • version（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domains/{id}/delete

Disable and observe upstream before deletion and managed DNS cleanup; retain history

操作标识：openAPILifecycledelete · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 503

  • id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domains/{id}/disable

Add manual stop and reconcile upstream suspension

操作标识：openAPILifecycledisable · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 503

  • id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domains/{id}/enable

Clear manual stop; other active reasons still suspend service

操作标识：openAPILifecycleenable · 响应状态：202 / 400 / 401 / 403 / 404 / 409 / 503

  • id（path，必填）
  • Idempotency-Key（header，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/domains/{id}/lifecycle

Read separate desired, upstream, filing, DNS and stop-reason state

操作标识：openAPIGetLifecycle · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 503

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domains/ownership-challenges

Issue a tenant-bound 24-hour ownership TXT challenge

操作标识：createOpenAPIDomainChallenge · 响应状态：201 / 400 / 401 / 403 / 404 / 409 / 503

  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/domains/ownership-challenges/{challenge_id}

Read this tenant's ownership challenge

操作标识：getOpenAPIDomainChallenge · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 503

  • challenge_id（path，必填）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
POST /openapi/v1/domains/ownership-challenges/{challenge_id}/verify

Verify the exact TXT value using an absolute DNS name

操作标识：verifyOpenAPIDomainChallenge · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • challenge_id（path，必填）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/logs

listLogsWithCredential

操作标识：listLogsWithCredential · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • domain_id（query，必填）
  • start（query，必填）
  • end（query，必填）
  • video（query，可选）
  • limit（query，可选）
  • after（query，可选）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/logs/{id}/download

downloadLogWithCredential

操作标识：downloadLogWithCredential · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • id（path，必填）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/metrics/{kind}

readMetricsWithCredential

操作标识：readMetricsWithCredential · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • kind（path，必填）
  • domain_ids（query，必填）
  • start（query，必填）
  • end（query，必填）
  • granularity（query，可选）
  • metric（query，可选）
  • area（query，可选）
  • regions（query，可选）
  • protocol（query，可选）
  • ip_protocol（query，可选）
  • domain_types（query，可选）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）
GET /openapi/v1/metrics/dictionaries/{kind}

readDictionaryWithCredential

操作标识：readDictionaryWithCredential · 响应状态：200 / 400 / 401 / 403 / 404 / 409 / 422 / 503

  • kind（path，必填）
  • X-CDN-Timestamp（header，必填）：UTC Unix seconds within 300 seconds of server time.
  • X-CDN-Nonce（header，必填）
  • X-CDN-Signature（header，必填）

时间与账务

时间字段使用 UTC，界面及业务账期默认按北京时间解释。流量采用十进制 GB，账务金额保留六位小数，支付与退款金额使用两位小数；HTTPS 请求用于监控，不收请求费用。

实际生效价格、延期流量和账期修订以账户内记录为准。查看计费说明 →