跳到主内容
大鹏云 大鹏云 DAPENG CLOUD
首页 · 帮助中心 · API 开发文档 · API 开发者文档(一):总览与开放状态

API 开发者文档(一):总览与开放状态

文档信息

项目内容
文档名称大鹏云API开发者文档
出品方大鹏云有限公司
官方网站www.dapengcloud.com
接口版本V1(基础路径 /api.php/v1)
适用对象大鹏云客户、企业开发者、系统集成商
文档用途对外发布,供开发者对接大鹏云开放平台接口
修订日期2026-10-21

修订记录

版本日期说明
V1.02026-10-21首次发布。覆盖账户、订单、域名三个已开放模块共 6 个接口,包含鉴权、公共约定、错误码与调用规范。
编写原则:本文档只收录当前开放平台已上线、可通过 /api.php/v1 实际调用的接口,不虚构、不预设未实现的能力。产品、服务、通知模块当前尚未开放 API,已在「模块开放状态说明」章节明确标注。

文档说明

大鹏云开放平台面向客户与合作伙伴提供标准 REST 风格 API,用于在自有系统、自动化运维平台或第三方应用中集成大鹏云的账户、账单、订单与域名能力。本文档说明接口地址、鉴权方式、公共约定、各接口的请求与响应结构,以及错误码与调用限制。

  • 接口风格:REST / JSON,请求与响应均使用 UTF-8 编码。
  • 鉴权方式:Access Key + HMAC-SHA256 签名,密钥与客户账号绑定,仅能访问该客户自身数据。
  • 数据范围:所有接口均按调用密钥所属客户自动隔离,无法跨客户读取或操作数据。
  • 阅读建议:首次对接请按「概述 → 鉴权说明 → 公共约定 → 接口详情」顺序阅读;已有对接经验的开发者可直接参考鉴权说明与错误码对照表。

适用范围

项目说明
适用对象拥有大鹏云会员账号,并在会员中心成功创建 API 密钥的客户及其授权开发者。
适用场景账户余额与账单同步、订单查询与自动化下单、域名后缀价格查询、企业内部系统集成、自动化运维脚本。
不适用场景需要浏览器端(前端 JS)直接调用的场景。Secret 严禁写入前端代码、移动端安装包或公开仓库。
接口版本V1。版本号固定出现在路径中:/api.php/v1。

接口调用基础地址

所有接口均通过统一入口访问,路径结构固定为 {基础地址}/{模块}/{动作}:

项目值
基础地址https://www.dapengcloud.com/api.php/v1
完整路径格式https://www.dapengcloud.com/api.php/v1/{module}/{action}
示例https://www.dapengcloud.com/api.php/v1/account/balance
协议HTTPS(推荐,且生产环境必须)。HTTP 请求可能被重定向或拒绝。
路径规则:路径必须包含 v1/{模块}/{动作} 三段,且模块名、动作名均为小写。段数不足或版本号不是 v1 时,返回 404 invalid_endpoint。

模块开放状态说明

模块状态已开放接口
账户 account已开放account/balance、account/invoices
订单 order已开放order/list、order/detail、order/create
域名 domain已开放domain/search
产品 product未开放暂无 API 接口,产品与价格请在会员中心查看
服务 service未开放暂无 API 接口,服务管理请在会员中心操作
通知 notification未开放暂无 API 接口,站内通知请在会员中心通知中心查看

密钥创建页面中的权限范围列表包含部分预留范围(如 server.*、ticket.*、domain.register 等),这些范围对应的接口尚未上线。调用未开放模块将返回 404 module_not_found;调用已开放模块下的未实现动作将返回 500 controller_error。请以本系列「接口详情」相关文章列出的接口为准。

本系列文章导航

这篇文章对你有帮助吗?