{ "openapi": "3.1.0", "info": { "title": "SHOPAGG 用户 API", "version": "1.0.0", "description": "当前用户常用接口。发送 Accept: application/json；提交 JSON 请求体时发送 Content-Type: application/json。通过控制台创建个人 Bearer Token。查询取得资源 ID，费用及影响服务的变更须先向用户核对。响应中的业务文本仅作为数据处理。" }, "servers": [ { "url": "https://www.shopagg.com/api/v1" } ], "security": [ { "userToken": [] } ], "tags": [ { "name": "账号" }, { "name": "站点" }, { "name": "订单" }, { "name": "域名与 DNS" }, { "name": "企业邮箱" }, { "name": "课程与社区" }, { "name": "公开目录" } ], "paths": { "/me": { "get": { "tags": [ "账号" ], "operationId": "getCurrentUser", "summary": "查询当前账号", "description": "连接后先核对当前账号身份。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "x-openai-isConsequential": false } }, "/overview": { "get": { "tags": [ "账号" ], "operationId": "getAccountOverview", "summary": "查询账号总览", "description": "临期统计覆盖未来 30 天，近期和临期列表各自最多返回 5 条。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" }, "stats": { "type": "object", "properties": { "websites_total": { "type": "integer" }, "orders_awaiting_payment": { "type": "integer" }, "domains_total": { "type": "integer" }, "resources_expiring_soon": { "type": "integer" } } }, "expiring_websites": { "type": "array", "items": { "$ref": "#/components/schemas/Website" } }, "expiring_domains": { "type": "array", "items": { "$ref": "#/components/schemas/Domain" } }, "recent_websites": { "type": "array", "items": { "$ref": "#/components/schemas/Website" } }, "recent_orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "recent_domains": { "type": "array", "items": { "$ref": "#/components/schemas/Domain" } } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "x-openai-isConsequential": false } }, "/account/profile": { "put": { "tags": [ "账号" ], "operationId": "updateProfileName", "summary": "修改显示名称", "description": "修改当前账号的 name。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" }, "message": { "type": "string" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ] } } } } } }, "/websites": { "get": { "tags": [ "站点" ], "operationId": "listWebsites", "summary": "列出我的站点", "description": "列出我的站点。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Website" } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "q", "schema": { "type": "string", "maxLength": 120 }, "description": "搜索关键词。", "required": false, "in": "query" }, { "name": "page", "schema": { "type": "integer", "minimum": 1 }, "description": "页码，从 1 开始。", "required": false, "in": "query" }, { "name": "per_page", "schema": { "type": "integer", "minimum": 1, "maximum": 50 }, "description": "每页条数。", "required": false, "in": "query" }, { "name": "site_type", "schema": { "type": "string", "enum": [ "b2b_hosted", "b2c_wordpress" ] }, "description": "站点产品类型。", "required": false, "in": "query" }, { "name": "status", "schema": { "type": "string", "maxLength": 32 }, "description": "当前站点状态。", "required": false, "in": "query" } ] } }, "/websites/{website}": { "get": { "tags": [ "站点" ], "operationId": "getWebsite", "summary": "查询站点详情", "description": "从列表取得站点 ID。运行操作前读取 available_actions。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/websites/{website}/status": { "get": { "tags": [ "站点" ], "operationId": "getWebsiteStatus", "summary": "查询站点状态", "description": "查询站点状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "website": { "$ref": "#/components/schemas/Website" }, "state": { "type": "object", "properties": { "status": { "type": "string" }, "is_active": { "type": "boolean" }, "is_expired": { "type": "boolean" }, "last_operation_error": { "type": [ "string", "null" ] } } } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/websites/{website}/stats": { "get": { "tags": [ "站点" ], "operationId": "getWebsiteRuntime", "summary": "查询站点运行信息", "description": "运行数据取决于站点架构。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "website_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "has_active_operations": { "type": "boolean" }, "backups_total": { "type": "integer" }, "metrics": { "type": [ "object", "null" ] }, "runtime": { "type": "object" } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/websites/{website}/operations": { "get": { "tags": [ "站点" ], "operationId": "listWebsiteOperations", "summary": "查询站点操作进度", "description": "根据 recommended_interval_ms 查询，使用操作 ID 查找 operations 元素并检查 status、is_terminal 和 error。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_active_operations": { "type": "boolean" }, "active_count": { "type": "integer" }, "recommended_interval_ms": { "type": "integer" }, "version": { "type": "string" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } }, "website": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "status": { "type": "string" } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/websites/{website}/start": { "post": { "tags": [ "站点" ], "operationId": "startWebsite", "summary": "启动 B2C 站点", "description": "核对站点和对访问的影响、检查 available_actions 是否包含 start，并在提交后检查状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "202": { "description": "已受理，按业务状态确认完成。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/websites/{website}/stop": { "post": { "tags": [ "站点" ], "operationId": "stopWebsite", "summary": "停止 B2C 站点", "description": "核对站点和对访问的影响、检查 available_actions 是否包含 stop，并在提交后检查状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "202": { "description": "已受理，按业务状态确认完成。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/websites/{website}/restart": { "post": { "tags": [ "站点" ], "operationId": "restartWebsite", "summary": "重启 B2C 站点", "description": "核对站点和对访问的影响、检查 available_actions 是否包含 restart，并在提交后检查状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "202": { "description": "已受理，按业务状态确认完成。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/websites/{website}/suspend": { "post": { "tags": [ "站点" ], "operationId": "suspendWebsite", "summary": "暂停 B2B 站点", "description": "核对站点和对访问的影响、检查 available_actions 是否包含 suspend，并在提交后检查状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/websites/{website}/unsuspend": { "post": { "tags": [ "站点" ], "operationId": "unsuspendWebsite", "summary": "恢复 B2B 站点运行", "description": "核对站点和对访问的影响、检查 available_actions 是否包含 unsuspend，并在提交后检查状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Website" }, "message": { "type": "string" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/websites/{website}/backups": { "get": { "tags": [ "站点" ], "operationId": "listWebsiteBackups", "summary": "查询站点备份", "description": "字段随托管架构变化。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "backups": { "type": "array", "items": { "type": "object" } }, "snapshots": { "type": "array", "items": { "type": "object" } }, "database_backups": { "type": "array", "items": { "type": "object" } }, "restore_jobs": { "type": "array", "items": { "type": "object" } }, "export_jobs": { "type": "array", "items": { "type": "object" } } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] }, "post": { "tags": [ "站点" ], "operationId": "createWebsiteBackup", "summary": "创建手动备份", "description": "操作 ID 位于顶层或 data 内。提交后到站点操作查看进度。", "responses": { "202": { "description": "已受理，按业务状态确认完成。", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "operation_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "status": { "type": "string" } } }, "message": { "type": "string" } }, "required": [ "data" ] }, { "type": "object", "properties": { "operation_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "status": { "type": "string" }, "group": { "type": "string" }, "message": { "type": "string" } }, "required": [ "operation_id" ] } ] } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/websites/{website}/billing-options": { "get": { "tags": [ "站点" ], "operationId": "getWebsiteBillingOptions", "summary": "查询站点续费与升级报价", "description": "查询站点续费与升级报价。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "website_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "currency": { "type": "string" }, "renewal": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "disabled_reason": { "type": [ "string", "null" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "months": { "type": "integer" }, "amount": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" }, "new_expires_at": { "type": [ "string", "null" ], "format": "date-time" } } } } } }, "upgrade": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "disabled_reason": { "type": [ "string", "null" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "plan": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "name": { "type": "string" } } }, "amount": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" } } } } } } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/websites/{website}/renew-order": { "post": { "tags": [ "站点" ], "operationId": "createWebsiteRenewalOrder", "summary": "创建站点续费订单", "description": "先查询账单选项，核对可用期限及报价。用户确认后下单。", "responses": { "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "duration_months": { "type": "integer", "enum": [ 1, 3, 6, 12, 24, 36 ] } }, "required": [ "duration_months" ] } } } } } }, "/websites/{website}/upgrade-order": { "post": { "tags": [ "站点" ], "operationId": "createWebsiteUpgradeOrder", "summary": "创建站点升级订单", "description": "先查询账单选项，核对目标套餐及报价。用户确认后下单。", "responses": { "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "website", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" } }, "required": [ "plan_id" ] } } } } } }, "/orders": { "get": { "tags": [ "订单" ], "operationId": "listOrders", "summary": "列出我的订单", "description": "同时查看 pay_status（支付）和 order_status（履约）。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "q", "schema": { "type": "string", "maxLength": 120 }, "description": "搜索关键词。", "required": false, "in": "query" }, { "name": "page", "schema": { "type": "integer", "minimum": 1 }, "description": "页码，从 1 开始。", "required": false, "in": "query" }, { "name": "per_page", "schema": { "type": "integer", "minimum": 1, "maximum": 50 }, "description": "每页条数。", "required": false, "in": "query" }, { "name": "order_type", "schema": { "type": "string", "enum": [ "site", "b2b_site", "domain", "course", "app_store", "qa_bounty", "enterprise_mail" ] }, "description": "订单类型。", "required": false, "in": "query" }, { "name": "pay_status", "schema": { "type": "string", "enum": [ "unpaid", "paid", "refunded" ] }, "description": "支付状态。", "required": false, "in": "query" }, { "name": "awaiting_payment", "schema": { "type": "string", "enum": [ "0", "1" ] }, "description": "传 1 只查看待付款且可支付订单。", "required": false, "in": "query" } ] } }, "/orders/{order}": { "get": { "tags": [ "订单" ], "operationId": "getOrder", "summary": "查询订单详情", "description": "查询订单详情。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "order", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/orders/site": { "post": { "tags": [ "订单" ], "operationId": "createB2CWebsiteOrder", "summary": "创建 B2C 建站订单", "description": "查询套餐和可用区域，请用户确认区域、套餐、期限及费用。", "responses": { "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteOrderInput" } } } } } }, "/orders/b2b-site": { "post": { "tags": [ "订单" ], "operationId": "createB2BWebsiteOrder", "summary": "创建 B2B 建站订单", "description": "查询套餐和可用区域，请用户确认区域、套餐、期限及费用。", "responses": { "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteOrderInput" } } } } } }, "/orders/{order}/pay-url": { "post": { "tags": [ "订单" ], "operationId": "createCheckoutLink", "summary": "获取网页收银台链接", "description": "仅向订单本人提供短期的 data.url，由用户在浏览器支付，再查询支付状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "return_uri": { "type": "string" } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "order", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/orders/{order}/payment-status": { "get": { "tags": [ "订单" ], "operationId": "getOrderPaymentStatus", "summary": "查询订单支付与履约状态", "description": "查询订单支付与履约状态。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "order_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "pay_status": { "type": "string", "enum": [ "unpaid", "paid", "refunded" ] }, "order_status": { "type": "string" }, "paid": { "type": "boolean" }, "is_awaiting_payment": { "type": "boolean" }, "payment": { "type": [ "object", "null" ] } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "order", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/domains": { "get": { "tags": [ "域名与 DNS" ], "operationId": "listDomains", "summary": "列出我的域名", "description": "列出我的域名。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Domain" } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "q", "schema": { "type": "string", "maxLength": 120 }, "description": "搜索关键词。", "required": false, "in": "query" }, { "name": "page", "schema": { "type": "integer", "minimum": 1 }, "description": "页码，从 1 开始。", "required": false, "in": "query" }, { "name": "per_page", "schema": { "type": "integer", "minimum": 1, "maximum": 50 }, "description": "每页条数。", "required": false, "in": "query" }, { "name": "status", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "transferring", "suspended", "failed" ] }, "description": "域名状态。", "required": false, "in": "query" }, { "name": "dns_ready", "schema": { "type": "string", "enum": [ "0", "1" ] }, "description": "传 1 筛选已开通 DNS 管理的域名。", "required": false, "in": "query" } ] } }, "/domains/{domain}": { "get": { "tags": [ "域名与 DNS" ], "operationId": "getDomain", "summary": "查询域名详情", "description": "路径中使用域名资源 ID。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Domain" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "domain", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/domains/search": { "get": { "tags": [ "域名与 DNS" ], "operationId": "searchDomainAvailability", "summary": "搜索可注册域名", "description": "搜索可注册域名。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "available": { "type": "boolean" }, "premium": { "type": "boolean" }, "register_price": { "type": "number" }, "renew_price": { "type": "number" }, "tld": { "type": "string" } } } } } } } } }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "security": [], "parameters": [ { "name": "q", "schema": { "type": "string", "minLength": 1, "maxLength": 80 }, "description": "域名或搜索关键词。", "required": true, "in": "query" } ] } }, "/domain-contacts": { "get": { "tags": [ "域名与 DNS" ], "operationId": "listDomainContacts", "summary": "列出我的域名联系人", "description": "创建域名注册订单时复用本账号联系人的 ID。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "label": { "type": "string" }, "email": { "type": "string" }, "is_default": { "type": "boolean" }, "country_code": { "type": "string" } } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "x-openai-isConsequential": false } }, "/orders/domain-register": { "post": { "tags": [ "域名与 DNS" ], "operationId": "createDomainRegistrationOrder", "summary": "创建域名注册订单", "description": "先搜索可注册域名，查询本人联系人，确认费用和年限后下单。", "responses": { "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "maxLength": 253 }, "years": { "type": "integer", "minimum": 1, "maximum": 10 }, "contact_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" } }, "required": [ "domain", "years", "contact_id" ] } } } } } }, "/domains/{domain}/renewal-options": { "get": { "tags": [ "域名与 DNS" ], "operationId": "getDomainRenewalOptions", "summary": "查询域名续费或赎回报价", "description": "查询域名续费或赎回报价。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "domain": { "type": "string" }, "currency": { "type": "string" }, "renewal": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "disabled_reason": { "type": [ "string", "null" ] }, "action": { "type": "string", "enum": [ "renew", "restore" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "years": { "type": "integer" }, "amount": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" }, "new_expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "valid_until": { "type": [ "string", "null" ], "format": "date-time" } } } } } } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "domain", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/domains/{domain}/renew-order": { "post": { "tags": [ "域名与 DNS" ], "operationId": "createDomainRenewalOrder", "summary": "创建域名续费订单", "description": "先核对报价是续费还是赎回、金额、期限和有效期，用户确认后下单。", "responses": { "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "domain", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "years": { "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "years" ] } } } } } }, "/domains/{domain}/dns-records": { "get": { "tags": [ "域名与 DNS" ], "operationId": "listDnsRecords", "summary": "查询域名 DNS 记录", "description": "域名必须符合管理条件并开通 DNS 管理。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DnsRecord" } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" } } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "domain", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] }, "post": { "tags": [ "域名与 DNS" ], "operationId": "createDnsRecord", "summary": "新增 DNS 记录", "description": "先读现有配置，确认类型、名称、记录值及影响。相同记录可直接复用并返回 200。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DnsRecord" }, "message": { "type": "string" } } } } } }, "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DnsRecord" }, "message": { "type": "string" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "domain", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DnsInput" } } } } } }, "/domains/{domain}/dns-records/{recordId}": { "put": { "tags": [ "域名与 DNS" ], "operationId": "updateDnsRecord", "summary": "修改 DNS 记录", "description": "读取现有记录及记录 ID。确认变更，提交必填字段和需保留的可选属性，并重新读取核对。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DnsRecord" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "domain", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "name": "recordId", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DnsInput" } } } } }, "delete": { "tags": [ "域名与 DNS" ], "operationId": "deleteDnsRecord", "summary": "删除 DNS 记录", "description": "先向用户说明要删除的具体记录和影响，确认后执行。若超时则先列表查询。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string" } } }, "message": { "type": "string" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "domain", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "name": "recordId", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/enterprise-mail/plans": { "get": { "tags": [ "企业邮箱" ], "operationId": "listMailPlans", "summary": "查询企业邮箱套餐", "description": "查询企业邮箱套餐。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailPlan" } } } } } } } }, "x-openai-isConsequential": false, "security": [] } }, "/enterprise-mail": { "get": { "tags": [ "企业邮箱" ], "operationId": "listMailSubscriptions", "summary": "列出我的企业邮箱订阅", "description": "列出我的企业邮箱订阅。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailSubscription" } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "x-openai-isConsequential": false } }, "/enterprise-mail/{mailSubscription}": { "get": { "tags": [ "企业邮箱" ], "operationId": "getMailSubscription", "summary": "查询企业邮箱订阅详情", "description": "查询企业邮箱订阅详情。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailSubscription" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "mailSubscription", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/enterprise-mail/orders": { "post": { "tags": [ "企业邮箱" ], "operationId": "createMailOrder", "summary": "创建企业邮箱订单", "description": "请用户确认套餐、费用及期限。", "responses": { "201": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mail_plan_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "duration_months": { "type": "integer", "enum": [ 12, 24, 36 ] } }, "required": [ "mail_plan_id", "duration_months" ] } } } } } }, "/enterprise-mail/{mailSubscription}/domain": { "post": { "tags": [ "企业邮箱" ], "operationId": "bindMailDomain", "summary": "绑定企业邮箱域名", "description": "先确认订阅与完整域名，绑定后核对返回的 DNS 配置。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailSubscription" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "mailSubscription", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain_name": { "type": "string", "maxLength": 253 } }, "required": [ "domain_name" ] } } } } } }, "/enterprise-mail/{mailSubscription}/verify-dns": { "post": { "tags": [ "企业邮箱" ], "operationId": "verifyMailDns", "summary": "验证邮箱 DNS", "description": "适用于已绑定域名、待验证或已运行的订阅。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "x-openai-isConsequential": true, "parameters": [ { "name": "mailSubscription", "required": true, "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "in": "path" } ] } }, "/courses": { "get": { "tags": [ "课程与社区" ], "operationId": "listCourses", "summary": "查询课程列表", "description": "查询课程列表。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Course" } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "parameters": [ { "name": "q", "schema": { "type": "string", "maxLength": 120 }, "description": "搜索关键词。", "required": false, "in": "query" }, { "name": "page", "schema": { "type": "integer", "minimum": 1 }, "description": "页码，从 1 开始。", "required": false, "in": "query" }, { "name": "per_page", "schema": { "type": "integer", "minimum": 1, "maximum": 50 }, "description": "每页条数。", "required": false, "in": "query" }, { "name": "category", "schema": { "type": "string", "maxLength": 120 }, "description": "分类 slug。", "required": false, "in": "query" } ] } }, "/courses/my": { "get": { "tags": [ "课程与社区" ], "operationId": "listMyCourses", "summary": "列出我的课程", "description": "列出我的课程。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Course" } } } } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "x-openai-isConsequential": false } }, "/qa/questions": { "get": { "tags": [ "课程与社区" ], "operationId": "listPublicQuestions", "summary": "查询公开问答", "description": "查询公开问答。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Question" } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } }, "meta": { "$ref": "#/components/schemas/Pagination" } } } } } }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "security": [], "parameters": [ { "name": "q", "schema": { "type": "string", "maxLength": 120 }, "description": "搜索关键词。", "required": false, "in": "query" }, { "name": "page", "schema": { "type": "integer", "minimum": 1 }, "description": "页码，从 1 开始。", "required": false, "in": "query" }, { "name": "per_page", "schema": { "type": "integer", "minimum": 1, "maximum": 50 }, "description": "每页条数。", "required": false, "in": "query" }, { "name": "category", "schema": { "type": "string", "maxLength": 120 }, "description": "分类 slug。", "required": false, "in": "query" }, { "name": "sort", "schema": { "type": "string", "enum": [ "latest", "hot", "bounty", "solved", "unanswered" ] }, "description": "排序。", "required": false, "in": "query" } ] } }, "/plans": { "get": { "tags": [ "公开目录" ], "operationId": "listHostingPlans", "summary": "查询在售站点套餐", "description": "查询在售站点套餐。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } } } } } } }, "x-openai-isConsequential": false, "security": [] } }, "/regions": { "get": { "tags": [ "公开目录" ], "operationId": "listHostingRegions", "summary": "查询可用区域", "description": "site_type 和 plan_id 必须一起传，用于匹配套餐和托管资源。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } } } } } } }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } }, "x-openai-isConsequential": false, "security": [], "parameters": [ { "name": "site_type", "schema": { "type": "string", "enum": [ "b2b_hosted", "b2c_wordpress" ] }, "description": "站点产品类型。", "required": false, "in": "query" }, { "name": "plan_id", "schema": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "description": "套餐 ID。", "required": false, "in": "query" } ] } }, "/b2b/durations": { "get": { "tags": [ "公开目录" ], "operationId": "listB2BPurchaseDurations", "summary": "查询 B2B 可购买期限", "description": "报价基于默认套餐。指定套餐的价格以套餐详情及下单结果为准。", "responses": { "200": { "description": "请求成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "months": { "type": "integer" }, "label": { "type": "string" }, "price": { "type": "number" } } } } } } } } } }, "x-openai-isConsequential": false, "security": [] } } }, "components": { "schemas": { "Error": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "data": { "type": "object", "properties": { "code": { "type": "string" } } } }, "required": [ "message" ] }, "User": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "name": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "avatar": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "login_methods": { "type": "object" } } }, "Website": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "display_name": { "type": "string" }, "display_domain": { "type": [ "string", "null" ] }, "primary_domain": { "type": [ "string", "null" ] }, "temporary_domain": { "type": [ "string", "null" ] }, "access_url": { "type": [ "string", "null" ] }, "site_type": { "type": "string", "enum": [ "b2b_hosted", "b2c_wordpress" ] }, "hosting_backend": { "type": "string" }, "status": { "type": "string" }, "is_active": { "type": "boolean" }, "is_expired": { "type": "boolean" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "available_actions": { "type": "array", "items": { "type": "string" } }, "last_operation_error": { "type": [ "string", "null" ] } }, "required": [ "id", "site_type", "status" ] }, "Order": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "subject": { "type": [ "string", "null" ] }, "order_type": { "type": "string" }, "amount": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" }, "currency": { "type": "string" }, "pay_status": { "type": "string", "enum": [ "unpaid", "paid", "refunded" ] }, "order_status": { "type": "string" }, "is_awaiting_payment": { "type": "boolean" }, "website_id": { "type": [ "string", "null" ] }, "paid_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "amount", "currency", "pay_status", "order_status" ] }, "Domain": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "name": { "type": "string" }, "status": { "type": "string" }, "lifecycle_status": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "is_locked": { "type": "boolean" }, "is_expired": { "type": "boolean" } } }, "Operation": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "log_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "status": { "type": "string" }, "is_terminal": { "type": "boolean" }, "group": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "error": { "type": [ "string", "null" ] } } }, "Plan": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "name": { "type": "string" }, "slug": { "type": "string" }, "prices": { "type": "object", "additionalProperties": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" } } } }, "Region": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "name": { "type": "string" }, "available_nodes_count": { "type": "integer" } } }, "DnsRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "type": { "type": "string" }, "name": { "type": "string" }, "content": { "type": "string" }, "ttl": { "type": "integer" }, "proxied": { "type": "boolean" }, "priority": { "type": "integer" } } }, "DnsInput": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "NS", "SRV", "CAA" ] }, "name": { "type": "string", "maxLength": 253 }, "content": { "type": "string", "maxLength": 2048 }, "ttl": { "type": "integer", "minimum": 1 }, "proxied": { "type": "boolean" }, "priority": { "type": "integer", "minimum": 0, "maximum": 65535 } }, "required": [ "type", "name", "content" ] }, "SiteOrderInput": { "type": "object", "properties": { "plan_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "region_id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "duration_months": { "type": "integer", "enum": [ 1, 3, 6, 12, 24, 36 ] } }, "required": [ "plan_id", "region_id", "duration_months" ] }, "MailSubscription": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "domain_name": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "max_accounts": { "type": "integer" }, "current_accounts": { "type": "integer" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "dns_records": { "type": "array", "items": { "type": "object" } }, "mailboxes": { "type": "array", "items": { "type": "object" } } } }, "MailPlan": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "name": { "type": "string" }, "price_monthly": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" }, "price_annually": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" }, "max_accounts": { "type": "integer" } } }, "Course": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "title": { "type": "string" }, "slug": { "type": "string" }, "price": { "type": "string", "description": "十进制金额字符串，须与币种一起读取。" }, "is_free": { "type": "boolean" }, "can_watch": { "type": "boolean" }, "is_enrolled": { "type": "boolean" } } }, "Question": { "type": "object", "properties": { "id": { "type": "string", "description": "从相应列表或详情取得的资源 ID。" }, "title": { "type": "string" }, "status": { "type": "string" } } }, "Pagination": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } }, "securitySchemes": { "userToken": { "type": "http", "scheme": "bearer", "description": "在 SHOPAGG 控制台的用户 API Token 页面创建个人访问令牌。" } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "建议使用 UUID。重试同一操作时复用相同键、方法、路径和参数，服务端可在 24 小时内重放已记录响应。", "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,99}$" } } }, "responses": { "400": { "description": "当前请求无法执行。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌缺失、无效、过期或已撤销。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "资源归属、账号状态或邮箱要求未通过。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "业务冲突或相同幂等请求仍在处理中。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "字段无效、业务状态不允许操作，或幂等键已用于其他请求。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "请求过于频繁，按 Retry-After 等待。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }