接口说明
通用接口规范、请求地址、响应结构与错误码说明。
接口请求地址
API 请求地址为 https://api.dizcloud.com
接口响应
所有接口采用统一的规范。接口返回值分两种情况:正常、异常情况下返回不同规格的数据。
异常响应
当接口调用失败时,返回异常响应,此时 HTTP Status Code 可能为 4xx 或者 5xx。返回的异常响应 HTTP Body 格式示例如下:
{
"code": 400031,
"desc": "无效所有权",
"reqId": "23dsadas-232123-dsad2232-232dmvcdf"
}字段说明:
| 字段 | 类型 | 含义 |
|---|---|---|
| code | number | 错误码,参见错误码定义 |
| desc | string | 错误描述 |
| reqId | string | 请求唯一标识 |
正常响应
当接口调用成功时,HTTP Status Code 为 200。每个响应体中都包含 reqId 字段,表示本次请求的唯一标识。响应 Body 中的data 参考各个 API 的定义,注意 data 有可能为空。
{
"reqId": "d3dwd334-fidas2323-2321da-dkla023",
"data": {
"foo": 1,
"bar": "hello"
}
}字段说明:
| 字段 | 类型 | 说明 |
|---|---|---|
| reqId | string | 请求唯一标识 |
| data | 参考各个接口定义 | 可能为 null或者不返回该字段 |
错误码
| 错误码 | 类型 | 含义 |
|---|---|---|
| 400001 | number | 参数异常 |
| 400006 | number | 内部错误 |
| 400008 | number | 鉴权失败 |
| 400028 | number | 操作对象不存在 |
| 400029 | number | 超出限额 |
| 400030 | number | 服务不可用,超过并发连接数 |
| 400031 | number | 无效域名所有权 |
| 400032 | number | 请求体不合法 |
| 400033 | number | 超出时间范围 |
| 400034 | number | 结束时间不能早于开始时间 |
| 400035 | number | 不在服务中的域名 |
| 400036 | number | 请求已过期 |