b450b512a2
- 添加 mipu-api 作为 git submodule (Claude Code Skill) - 迁移 API 文档源文件到 docs/ 目录统一维护 - 添加 Gitea Actions 工作流：tag推送自动打包docs并发布Release - Skill 运行时自动从 mipu-open Release 下载最新文档 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
88 lines
2.4 KiB
Markdown
88 lines
2.4 KiB
Markdown
<!-- mipuyun-api-doc: mailbox-domain-detail -->
|
||
# mailbox/domain/detail - 域名详情
|
||
|
||
# 查询域名详情(mailbox/domain/detail) API 说明文档
|
||
|
||
## 使用场景
|
||
|
||
> 1. 查看指定域名的详细配置信息
|
||
> 1. 管理员需要了解域名的DNS配置和验证状态
|
||
|
||
## 错误场景(不应该使用本接口的场景)
|
||
|
||
> 1. 查询的域名ID不存在
|
||
> 1. 查询的域名不属于当前客户（权限不足）
|
||
|
||
## 性能指标
|
||
|
||
> - 响应速度：98% 的请求响应速度 < 500ms
|
||
|
||
## 请求说明
|
||
|
||
| **请求地址** | https://${endpoint}/mailbox/domain/detail |
|
||
| --- | --- |
|
||
| **请求方法** | POST |
|
||
|
||
## 请求参数
|
||
|
||
### Header
|
||
|
||
| **参数名称** | **类型** | **是否必选** | **示例值** | **说明** |
|
||
| --- | --- | --- | --- | --- |
|
||
| Content-Type | String | 是 | application/json | 固定值，指定请求体格式为 JSON |
|
||
| Accept-Encoding | String | 是 | gzip, deflate, br | 必须要填写，否则服务器会拒绝 |
|
||
| client-key | String | 是 | xxxxx | 联系我们获取生产环境key |
|
||
| client-secret | String | 是 | xxxxx | 联系我们获取生产环境secret |
|
||
|
||
### 请求体
|
||
|
||
```json
|
||
{
|
||
"domainId": 123
|
||
}
|
||
```
|
||
|
||
#### 参数详情
|
||
|
||
| **参数名称** | **类型** | **是否必选** | **示例值** | **说明** |
|
||
| --- | --- | --- | --- | --- |
|
||
| domainId | Long | 是 | 123 | 域名ID |
|
||
|
||
## 返回参数
|
||
|
||
| **参数名称** | **类型** | **示例值** | **说明** |
|
||
| --- | --- | --- | --- |
|
||
| domainId | Long | 123 | 域名唯一标识 |
|
||
| domainName | String | example.com | 域名名称 |
|
||
| status | String | ACTIVE | 域名状态 |
|
||
| dnsVerified | Boolean | true | DNS验证状态 |
|
||
| createTime | String | 2025-01-01T10:00:00Z | 域名创建时间 |
|
||
| updateTime | String | 2025-01-02T10:00:00Z | 域名更新时间 |
|
||
| mxRecord | String | mail.example.com | MX记录（如已配置） |
|
||
| txtRecord | String | v=spf1 include:... | SPF记录（如已配置） |
|
||
|
||
## 返回示例
|
||
|
||
```json
|
||
{
|
||
"domainId": 123,
|
||
"domainName": "example.com",
|
||
"status": "ACTIVE",
|
||
"dnsVerified": true,
|
||
"createTime": "2025-01-01T10:00:00Z",
|
||
"updateTime": "2025-01-02T10:00:00Z",
|
||
"mxRecord": "mail.example.com",
|
||
"txtRecord": "v=spf1 include:_spf.example.com ~all"
|
||
}
|
||
```
|
||
|
||
## 错误码说明
|
||
|
||
| **错误码** | **说明** |
|
||
| --- | --- |
|
||
| 400 | 请求参数错误，domainId 格式不正确 |
|
||
| 401 | 认证失败，client-key 或 client-secret 无效 |
|
||
| 403 | 权限不足，无权访问该域名信息 |
|
||
| 404 | 域名不存在 |
|
||
| 500 | 服务器内部错误 |
|