init: mipu-open 对外开放项目统一管理仓库
- 添加 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>
This commit is contained in:
90
docs/11-01_mailbox-domain-list.md
Normal file
90
docs/11-01_mailbox-domain-list.md
Normal file
@@ -0,0 +1,90 @@
|
||||
<!-- mipuyun-api-doc: mailbox-domain-list -->
|
||||
# mailbox/domain/list - 域名列表
|
||||
|
||||
## 概述
|
||||
|
||||
查询当前客户已绑定的所有邮箱域名列表。
|
||||
|
||||
### 使用场景
|
||||
|
||||
- 查看当前客户已绑定的所有邮箱域名列表
|
||||
- 管理员需要了解企业邮箱的域名配置情况
|
||||
|
||||
## 请求说明
|
||||
|
||||
| 项目 | 值 |
|
||||
|------|-----|
|
||||
| **请求地址** | `https://${endpoint}/mailbox/domain/list` |
|
||||
| **请求方法** | POST |
|
||||
| **注意事项** | 无需请求体,系统自动从请求上下文中提取 clientCode |
|
||||
|
||||
### Header 参数
|
||||
|
||||
| 参数名称 | 类型 | 是否必选 | 示例值 | 说明 |
|
||||
|----------|------|----------|--------|------|
|
||||
| Content-Type | String | 是 | application/json | 固定值,指定请求体格式为 JSON |
|
||||
| Accept-Encoding | String | 是 | gzip, deflate, br | 必须要填写,否则服务器会拒绝 |
|
||||
| client-key | String | 是 | xxxxx | 联系我们获取生产环境 key |
|
||||
| client-secret | String | 是 | xxxxx | 联系我们获取生产环境 secret |
|
||||
|
||||
## 返回参数
|
||||
|
||||
返回 `MailboxDomain` 对象数组:
|
||||
|
||||
| 参数名称 | 类型 | 示例值 | 说明 |
|
||||
|----------|------|--------|------|
|
||||
| domainId | Long | 123 | 域名配置主键 |
|
||||
| domainName | String | example.com | 域名全称 |
|
||||
| status | Integer | 1 | 状态:0-待审核,1-已启用,2-已禁用,3-已删除 |
|
||||
| statusText | String | 已启用 | 状态文本描述 |
|
||||
| verifyStatus | Integer | 2 | 验证状态:0-未验证,1-验证中,2-验证通过,3-验证失败 |
|
||||
| verifyStatusText | String | 验证通过 | 验证状态文本 |
|
||||
| verifyToken | String | a1b2c3d4 | DNS验证令牌 |
|
||||
| verifyHost | String | _mailbox-verify-a1b2c3d4 | DNS验证主机名 |
|
||||
| verifyTime | String | 2025-01-01T10:00:00Z | 验证通过时间(ISO 8601格式) |
|
||||
| createTime | String | 2025-01-01T10:00:00Z | 创建时间(ISO 8601格式) |
|
||||
| updateTime | String | 2025-01-02T10:00:00Z | 更新时间(ISO 8601格式) |
|
||||
| remark | String | 备注信息 | 备注 |
|
||||
|
||||
## 返回示例
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"domainId": 123,
|
||||
"domainName": "example.com",
|
||||
"status": 1,
|
||||
"statusText": "已启用",
|
||||
"verifyStatus": 2,
|
||||
"verifyStatusText": "验证通过",
|
||||
"verifyToken": "a1b2c3d4",
|
||||
"verifyHost": "_mailbox-verify-a1b2c3d4",
|
||||
"verifyTime": "2025-01-01T10:00:00Z",
|
||||
"createTime": "2025-01-01T10:00:00Z",
|
||||
"updateTime": "2025-01-02T10:00:00Z",
|
||||
"remark": "主域名"
|
||||
},
|
||||
{
|
||||
"domainId": 124,
|
||||
"domainName": "company.com",
|
||||
"status": 0,
|
||||
"statusText": "待审核",
|
||||
"verifyStatus": 0,
|
||||
"verifyStatusText": "未验证",
|
||||
"verifyToken": "e5f6g7h8",
|
||||
"verifyHost": "_mailbox-verify-e5f6g7h8",
|
||||
"verifyTime": null,
|
||||
"createTime": "2025-01-03T10:00:00Z",
|
||||
"updateTime": "2025-01-03T10:00:00Z",
|
||||
"remark": "备用域名"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## 错误码说明
|
||||
|
||||
| 错误码 | 说明 |
|
||||
|--------|------|
|
||||
| 401 | 认证失败,client-key 或 client-secret 无效 |
|
||||
| 403 | 权限不足,无权访问该客户的域名列表 |
|
||||
| 500 | 服务器内部错误 |
|
||||
Reference in New Issue
Block a user