53fb541846
覆盖 public/admin/node 三类共 289 个端点,按 P0/P1/P2 排序,为后续 acceptance 脚手架和 release workflow 提供输入。
57 KiB
57 KiB
API Acceptance Inventory
Generated from apis/admin/*.api, apis/public/*.api, and apis/node/*.api on 2026-06-03. This is an inventory only; it does not add acceptance test logic.
Summary
- API definition files scanned: 35 (public 12, admin 22, node 1)
- Endpoints inventoried: 289 (public 78, admin 205, node 6)
- MVP priority counts: P0 159, P1 67, P2 63
Priority Rules
- P0: login/auth, user identity and profile, subscription/package, order, node config, and core admin query paths.
- P1: common operational paths such as tickets, announcements, payment/config reads, logs, coupons, invite, documents, and non-critical updates.
- P2: destructive operations or paths with strong external side effects, including delete/batch delete, file upload, real SMS/email, OAuth/Telegram callbacks, app-store/payment webhooks, and other stateful batch jobs.
Source Files
public
apis/public/announcement.apiapis/public/document.apiapis/public/file.apiapis/public/iap.apiapis/public/order.apiapis/public/payment.apiapis/public/portal.apiapis/public/recovery.apiapis/public/redemption.apiapis/public/subscribe.apiapis/public/ticket.apiapis/public/user.api
admin
apis/admin/ads.apiapis/admin/announcement.apiapis/admin/application.apiapis/admin/auth.apiapis/admin/console.apiapis/admin/coupon.apiapis/admin/device.apiapis/admin/document.apiapis/admin/group.apiapis/admin/invite.apiapis/admin/log.apiapis/admin/marketing.apiapis/admin/order.apiapis/admin/payment.apiapis/admin/promo.apiapis/admin/redemption.apiapis/admin/server.apiapis/admin/subscribe.apiapis/admin/system.apiapis/admin/ticket.apiapis/admin/tool.apiapis/admin/user.api
node
apis/node/node.api
public Endpoints
| Domain | Method | Path | Request Type | Response Type | Auth | Priority | Notes |
|---|---|---|---|---|---|---|---|
| public | GET | /v1/public/announcement/list |
QueryAnnouncementRequest |
QueryAnnouncementResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Query announcement |
| public | GET | /v1/public/document/list |
- |
QueryDocumentListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get document list |
| public | GET | /v1/public/document/detail |
QueryDocumentDetailRequest |
Document |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get document detail |
| public | POST | /v1/public/file/upload |
FileUploadRequest |
FileUploadResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Upload file to RustFS;暂缓真实文件上传,需测试存储桶或 mock storage |
| public | POST | /v1/public/file/upload/init |
FileUploadInitRequest |
FileUploadInitResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Init file upload;暂缓真实文件上传,需测试存储桶或 mock storage |
| public | POST | /v1/public/file/upload/complete |
FileUploadCompleteRequest |
FileUploadCompleteResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Complete file upload;暂缓真实文件上传,需测试存储桶或 mock storage |
| public | POST | /v1/public/iap/apple/transactions/attach |
AttachAppleTransactionRequest |
AttachAppleTransactionResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Attach Apple Transaction;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/iap/apple/transactions/attach/id |
AttachAppleTransactionByIdRequest |
AttachAppleTransactionResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Attach Apple Transaction By Id;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/iap/apple/transactions/restore |
RestoreAppleTransactionsRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Restore Apple Transactions;订单/支付路径需沙箱网关与测试订单隔离 |
| public | GET | /v1/public/iap/apple/status |
- |
GetAppleStatusResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Get Apple IAP Status;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/order/pre |
PurchaseOrderRequest |
PreOrderResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Pre create order;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/order/purchase |
PurchaseOrderRequest |
PurchaseOrderResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: purchase Subscription;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/order/renewal |
RenewalOrderRequest |
RenewalOrderResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Renewal Subscription;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/order/reset |
ResetTrafficOrderRequest |
ResetTrafficOrderResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reset traffic;订单/支付路径需沙箱网关与测试订单隔离;状态变更操作,需隔离测试资源 |
| public | POST | /v1/public/order/recharge |
RechargeOrderRequest |
RechargeOrderResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Recharge;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/order/close |
CloseOrderRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Close order;订单/支付路径需沙箱网关与测试订单隔离 |
| public | GET | /v1/public/order/detail |
QueryOrderDetailRequest |
OrderDetail |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get order;订单/支付路径需沙箱网关与测试订单隔离 |
| public | GET | /v1/public/order/list |
QueryOrderListRequest |
QueryOrderListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get order list;订单/支付路径需沙箱网关与测试订单隔离 |
| public | GET | /v1/public/payment/methods |
- |
GetAvailablePaymentMethodsResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get available payment methods;订单/支付路径需沙箱网关与测试订单隔离 |
| public | GET | /v1/public/portal/payment-method |
- |
GetAvailablePaymentMethodsResponse |
设备校验(DeviceMiddleware) | P1 | 中间件: DeviceMiddleware;doc: Get available payment methods;订单/支付路径需沙箱网关与测试订单隔离 |
| public | GET | /v1/public/portal/subscribe |
GetSubscriptionRequest |
GetSubscriptionResponse |
设备校验(DeviceMiddleware) | P0 | 中间件: DeviceMiddleware;doc: Get Subscription |
| public | POST | /v1/public/portal/pre |
PrePurchaseOrderRequest |
PrePurchaseOrderResponse |
设备校验(DeviceMiddleware) | P0 | 中间件: DeviceMiddleware;doc: Pre Purchase Order;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/portal/purchase |
PortalPurchaseRequest |
PortalPurchaseResponse |
设备校验(DeviceMiddleware) | P2 | 中间件: DeviceMiddleware;doc: Purchase subscription;订单/支付路径需沙箱网关与测试订单隔离 |
| public | GET | /v1/public/portal/order/status |
QueryPurchaseOrderRequest |
QueryPurchaseOrderResponse |
设备校验(DeviceMiddleware) | P0 | 中间件: DeviceMiddleware;doc: Query Purchase Order;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/portal/order/checkout |
CheckoutOrderRequest |
CheckoutOrderResponse |
设备校验(DeviceMiddleware) | P0 | 中间件: DeviceMiddleware;doc: Purchase Checkout;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/recovery/send_code |
RecoverySendCodeRequest |
SendCodeResponse |
设备校验(DeviceMiddleware) | P2 | 中间件: DeviceMiddleware;doc: Send recovery verification code |
| public | POST | /v1/public/recovery/order |
RecoverOrderRequest |
RecoverOrderResponse |
设备校验(DeviceMiddleware) | P0 | 中间件: DeviceMiddleware;doc: Recover order subscription;订单/支付路径需沙箱网关与测试订单隔离 |
| public | POST | /v1/public/redemption |
RedeemCodeRequest |
RedeemCodeResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Redeem code |
| public | GET | /v1/public/subscribe/list |
QuerySubscribeListRequest |
QuerySubscribeListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe list |
| public | GET | /v1/public/subscribe/node/list |
- |
QueryUserSubscribeNodeListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user subscribe node info |
| public | GET | /v1/public/subscribe/group/list |
- |
QuerySubscribeGroupListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe group list |
| public | GET | /v1/public/ticket/list |
GetUserTicketListRequest |
GetUserTicketListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get ticket list |
| public | GET | /v1/public/ticket/detail |
GetUserTicketDetailRequest |
Ticket |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get ticket detail |
| public | PUT | /v1/public/ticket |
UpdateUserTicketStatusRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update ticket status |
| public | POST | /v1/public/ticket/follow |
CreateUserTicketFollowRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create ticket follow |
| public | POST | /v1/public/ticket |
CreateUserTicketRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create ticket |
| public | GET | /v1/public/user/info |
- |
User |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query User Info |
| public | PUT | /v1/public/user/notify |
UpdateUserNotifyRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Update User Notify |
| public | PUT | /v1/public/user/password |
UpdateUserPasswordRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update User Password |
| public | GET | /v1/public/user/subscribe |
- |
QueryUserSubscribeListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query User Subscribe |
| public | POST | /v1/public/user/unsubscribe/pre |
PreUnsubscribeRequest |
PreUnsubscribeResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Pre Unsubscribe |
| public | POST | /v1/public/user/unsubscribe |
UnsubscribeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Unsubscribe |
| public | GET | /v1/public/user/balance_log |
- |
QueryUserBalanceLogListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query User Balance Log |
| public | GET | /v1/public/user/affiliate/count |
- |
QueryUserAffiliateCountResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query User Affiliate Count |
| public | GET | /v1/public/user/affiliate/list |
QueryUserAffiliateListRequest |
QueryUserAffiliateListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query User Affiliate List |
| public | GET | /v1/public/user/bind_telegram |
- |
BindTelegramResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Bind Telegram;外部 OAuth/Telegram 依赖需 mock provider |
| public | POST | /v1/public/user/unbind_telegram |
- |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Unbind Telegram;外部 OAuth/Telegram 依赖需 mock provider |
| public | GET | /v1/public/user/commission_log |
QueryUserCommissionLogListRequest |
QueryUserCommissionLogListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query User Commission Log |
| public | POST | /v1/public/user/bind_oauth |
BindOAuthRequest |
BindOAuthResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Bind OAuth;外部 OAuth/Telegram 依赖需 mock provider |
| public | POST | /v1/public/user/bind_oauth/callback |
BindOAuthCallbackRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Bind OAuth Callback;外部回调路径需签名样例和重放保护用例;外部 OAuth/Telegram 依赖需 mock provider |
| public | GET | /v1/public/user/oauth_methods |
- |
GetOAuthMethodsResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Get OAuth Methods;外部 OAuth/Telegram 依赖需 mock provider |
| public | POST | /v1/public/user/unbind_oauth |
UnbindOAuthRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Unbind OAuth;外部 OAuth/Telegram 依赖需 mock provider |
| public | PUT | /v1/public/user/subscribe_token |
ResetUserSubscribeTokenRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reset User Subscribe Token;状态变更操作,需隔离测试资源 |
| public | GET | /v1/public/user/login_log |
GetLoginLogRequest |
GetLoginLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Login Log |
| public | GET | /v1/public/user/subscribe_log |
GetSubscribeLogRequest |
GetSubscribeLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Subscribe Log |
| public | POST | /v1/public/user/verify_email |
VerifyEmailRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Verify Email;暂缓真实邮件发送,需 mock 邮件队列 |
| public | PUT | /v1/public/user/bind_mobile |
UpdateBindMobileRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update Bind Mobile |
| public | PUT | /v1/public/user/bind_email |
UpdateBindEmailRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Update Bind Email;暂缓真实邮件发送,需 mock 邮件队列 |
| public | GET | /v1/public/user/devices |
- |
GetDeviceListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Device List |
| public | PUT | /v1/public/user/unbind_device |
UnbindDeviceRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Unbind Device |
| public | PUT | /v1/public/user/subscribe_note |
UpdateUserSubscribeNoteRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update User Subscribe Note |
| public | PUT | /v1/public/user/rules |
UpdateUserRulesRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update User Rules |
| public | POST | /v1/public/user/commission_withdraw |
CommissionWithdrawRequest |
WithdrawalLog |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Commission Withdraw;提现路径影响资金数据,需专用测试账号 |
| public | POST | /v1/public/user/withdrawal_cancel |
CancelWithdrawalRequest |
WithdrawalLog |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Cancel pending withdrawal;提现路径影响资金数据,需专用测试账号 |
| public | GET | /v1/public/user/withdrawal_log |
QueryWithdrawalLogListRequest |
QueryWithdrawalLogListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query Withdrawal Log;提现路径影响资金数据,需专用测试账号 |
| public | GET | /v1/public/user/device_online_statistics |
- |
GetDeviceOnlineStatsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Device Online Statistics |
| public | DELETE | /v1/public/user/current_user_account |
- |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete Current User Account;破坏性操作,需专用测试数据并校验回滚/幂等 |
| public | POST | /v1/public/user/bind_email_with_verification |
BindEmailWithVerificationRequest |
BindEmailWithVerificationResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Bind Email With Verification;暂缓真实邮件发送,需 mock 邮件队列 |
| public | POST | /v1/public/user/bind_invite_code |
BindInviteCodeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Bind Invite Code |
| public | POST | /v1/public/user/delete_account |
DeleteAccountRequest |
DeleteAccountResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete Account;破坏性操作,需专用测试数据并校验回滚/幂等 |
| public | GET | /v1/public/user/agent_downloads |
GetAgentDownloadsRequest |
GetAgentDownloadsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Agent Downloads |
| public | GET | /v1/public/user/agent_realtime |
GetAgentRealtimeRequest |
GetAgentRealtimeResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Agent Realtime |
| public | GET | /v1/public/user/invite_records |
GetInviteRecordsRequest |
GetInviteRecordsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Invite Records |
| public | GET | /v1/public/user/invite_sales |
GetInviteSalesRequest |
GetInviteSalesResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Invite Sales |
| public | POST | /v1/public/user/subscribe_status |
GetSubscribeStatusRequest |
GetSubscribeStatusResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Subscribe Status |
| public | GET | /v1/public/user/invite_stats |
GetUserInviteStatsRequest |
GetUserInviteStatsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get User Invite Stats |
| public | GET | /v1/public/user/traffic_stats |
GetUserTrafficStatsRequest |
GetUserTrafficStatsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get User Traffic Statistics |
| public | GET | /v1/public/user/device_ws_connect |
- |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Webosocket Device Connect |
admin Endpoints
| Domain | Method | Path | Request Type | Response Type | Auth | Priority | Notes |
|---|---|---|---|---|---|---|---|
| admin | POST | /v1/admin/ads |
CreateAdsRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create Ads |
| admin | PUT | /v1/admin/ads |
UpdateAdsRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update Ads |
| admin | DELETE | /v1/admin/ads |
DeleteAdsRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete Ads;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/ads/list |
GetAdsListRequest |
GetAdsListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get Ads List |
| admin | GET | /v1/admin/ads/detail |
GetAdsDetailRequest |
Ads |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Ads Detail |
| admin | POST | /v1/admin/announcement |
CreateAnnouncementRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create announcement |
| admin | PUT | /v1/admin/announcement |
UpdateAnnouncementRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update announcement |
| admin | GET | /v1/admin/announcement/list |
GetAnnouncementListRequest |
GetAnnouncementListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get announcement list |
| admin | DELETE | /v1/admin/announcement |
DeleteAnnouncementRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete announcement;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/announcement/detail |
GetAnnouncementRequest |
Announcement |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get announcement |
| admin | POST | /v1/admin/application |
CreateSubscribeApplicationRequest |
SubscribeApplication |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create subscribe application |
| admin | PUT | /v1/admin/application/subscribe_application |
UpdateSubscribeApplicationRequest |
SubscribeApplication |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update subscribe application |
| admin | GET | /v1/admin/application/subscribe_application_list |
GetSubscribeApplicationListRequest |
GetSubscribeApplicationListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe application list |
| admin | DELETE | /v1/admin/application/subscribe_application |
DeleteSubscribeApplicationRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete subscribe application;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/application/preview |
PreviewSubscribeTemplateRequest |
PreviewSubscribeTemplateResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Preview Template |
| admin | GET | /v1/admin/auth-method/list |
- |
GetAuthMethodListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get auth method list |
| admin | GET | /v1/admin/auth-method/config |
GetAuthMethodConfigRequest |
AuthMethodConfig |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get auth method config |
| admin | PUT | /v1/admin/auth-method/config |
UpdateAuthMethodConfigRequest |
AuthMethodConfig |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update auth method config |
| admin | POST | /v1/admin/auth-method/test_sms_send |
TestSmsSendRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Test sms send;暂缓真实短信发送,需 mock 短信服务 |
| admin | POST | /v1/admin/auth-method/test_email_send |
TestEmailSendRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Test email send;暂缓真实邮件发送,需 mock 邮件队列 |
| admin | GET | /v1/admin/auth-method/sms_platform |
- |
PlatformResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Get sms support platform;暂缓真实短信发送,需 mock 短信服务 |
| admin | GET | /v1/admin/auth-method/email_platform |
- |
PlatformResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Get email support platform;暂缓真实邮件发送,需 mock 邮件队列 |
| admin | GET | /v1/admin/console/server |
- |
ServerTotalDataResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query server total data |
| admin | GET | /v1/admin/console/revenue |
- |
RevenueStatisticsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query revenue statistics |
| admin | GET | /v1/admin/console/user |
- |
UserStatisticsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query user statistics |
| admin | GET | /v1/admin/console/ticket |
- |
TicketWaitRelpyResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query ticket wait reply |
| admin | POST | /v1/admin/coupon |
CreateCouponRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create coupon |
| admin | PUT | /v1/admin/coupon |
UpdateCouponRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update coupon |
| admin | DELETE | /v1/admin/coupon |
DeleteCouponRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete coupon;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | DELETE | /v1/admin/coupon/batch |
BatchDeleteCouponRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Batch delete coupon;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/coupon/list |
GetCouponListRequest |
GetCouponListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get coupon list |
| admin | POST | /v1/admin/document |
CreateDocumentRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create document |
| admin | PUT | /v1/admin/document |
UpdateDocumentRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update document |
| admin | DELETE | /v1/admin/document |
DeleteDocumentRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete document;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | DELETE | /v1/admin/document/batch |
BatchDeleteDocumentRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Batch delete document;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/document/list |
GetDocumentListRequest |
GetDocumentListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get document list |
| admin | GET | /v1/admin/document/detail |
GetDocumentDetailRequest |
Document |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get document detail |
| admin | GET | /v1/admin/group/node/list |
GetNodeGroupListRequest |
GetNodeGroupListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get node group list |
| admin | POST | /v1/admin/group/node |
CreateNodeGroupRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create node group |
| admin | PUT | /v1/admin/group/node |
UpdateNodeGroupRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update node group |
| admin | DELETE | /v1/admin/group/node |
DeleteNodeGroupRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete node group;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/group/config |
GetGroupConfigRequest |
GetGroupConfigResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get group config |
| admin | PUT | /v1/admin/group/config |
UpdateGroupConfigRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update group config |
| admin | POST | /v1/admin/group/recalculate |
RecalculateGroupRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Recalculate group |
| admin | GET | /v1/admin/group/recalculation/status |
- |
RecalculationState |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get recalculation status |
| admin | GET | /v1/admin/group/history |
GetGroupHistoryRequest |
GetGroupHistoryResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get group history |
| admin | GET | /v1/admin/group/export |
ExportGroupResultRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Export group result |
| admin | GET | /v1/admin/group/history/detail |
GetGroupHistoryDetailRequest |
GetGroupHistoryDetailResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get group history detail |
| admin | GET | /v1/admin/group/preview |
PreviewUserNodesRequest |
PreviewUserNodesResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Preview user nodes |
| admin | POST | /v1/admin/group/reset |
ResetGroupsRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Reset all groups;状态变更操作,需隔离测试资源 |
| admin | GET | /v1/admin/group/subscribe/mapping |
GetSubscribeGroupMappingRequest |
GetSubscribeGroupMappingResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe group mapping |
| admin | GET | /v1/admin/invite/list |
GetInviteManageListRequest |
GetInviteManageListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get invite manage list |
| admin | GET | /v1/admin/log/message/list |
GetMessageLogListRequest |
GetMessageLogListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get message log list |
| admin | GET | /v1/admin/log/email/list |
FilterLogParams |
FilterEmailLogResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Filter email log;暂缓真实邮件发送,需 mock 邮件队列 |
| admin | GET | /v1/admin/log/mobile/list |
FilterLogParams |
FilterMobileLogResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Filter mobile log |
| admin | GET | /v1/admin/log/subscribe/list |
FilterSubscribeLogRequest |
FilterSubscribeLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter subscribe log |
| admin | GET | /v1/admin/log/login/list |
FilterLoginLogRequest |
FilterLoginLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter login log |
| admin | GET | /v1/admin/log/register/list |
FilterRegisterLogRequest |
FilterRegisterLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter register log |
| admin | GET | /v1/admin/log/subscribe/reset/list |
FilterResetSubscribeLogRequest |
FilterResetSubscribeLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter reset subscribe log;状态变更操作,需隔离测试资源 |
| admin | GET | /v1/admin/log/subscribe/traffic/list |
FilterSubscribeTrafficRequest |
FilterSubscribeTrafficResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter user subscribe traffic log |
| admin | GET | /v1/admin/log/server/traffic/list |
FilterServerTrafficLogRequest |
FilterServerTrafficLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter server traffic log |
| admin | GET | /v1/admin/log/balance/list |
FilterBalanceLogRequest |
FilterBalanceLogResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Filter balance log |
| admin | GET | /v1/admin/log/commission/list |
FilterCommissionLogRequest |
FilterCommissionLogResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Filter commission log |
| admin | GET | /v1/admin/log/order/refund/list |
FilterOrderRefundLogRequest |
FilterOrderRefundLogResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter order refund log;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | GET | /v1/admin/log/gift/list |
FilterGiftLogRequest |
FilterGiftLogResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Filter gift log |
| admin | GET | /v1/admin/log/traffic/details |
FilterTrafficLogDetailsRequest |
FilterTrafficLogDetailsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter traffic log details |
| admin | GET | /v1/admin/log/setting |
- |
LogSetting |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get log setting |
| admin | POST | /v1/admin/log/setting |
LogSetting |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update log setting |
| admin | GET | /v1/admin/log/error_message/list |
GetErrorLogMessageListRequest |
GetErrorLogMessageListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get error log message list |
| admin | GET | /v1/admin/log/error_message/detail |
- |
GetErrorLogMessageDetailResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get error log message detail |
| admin | GET | /v1/admin/log/message/detail |
GetLogMessageRawRequest |
GetLogMessageRawResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get log message raw detail (temporary) |
| admin | POST | /v1/admin/marketing/email/batch/send |
CreateBatchSendEmailTaskRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Create a batch send email task;暂缓真实邮件发送,需 mock 邮件队列 |
| admin | GET | /v1/admin/marketing/email/batch/list |
GetBatchSendEmailTaskListRequest |
GetBatchSendEmailTaskListResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Get batch send email task list;暂缓真实邮件发送,需 mock 邮件队列 |
| admin | POST | /v1/admin/marketing/email/batch/stop |
StopBatchSendEmailTaskRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Stop a batch send email task;暂缓真实邮件发送,需 mock 邮件队列;状态变更操作,需隔离测试资源 |
| admin | POST | /v1/admin/marketing/email/batch/pre-send-count |
GetPreSendEmailCountRequest |
GetPreSendEmailCountResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Get pre-send email count;暂缓真实邮件发送,需 mock 邮件队列 |
| admin | POST | /v1/admin/marketing/email/batch/status |
GetBatchSendEmailTaskStatusRequest |
GetBatchSendEmailTaskStatusResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Get batch send email task status;暂缓真实邮件发送,需 mock 邮件队列 |
| admin | POST | /v1/admin/marketing/quota/create |
CreateQuotaTaskRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Create a quota task |
| admin | POST | /v1/admin/marketing/quota/pre-count |
QueryQuotaTaskPreCountRequest |
QueryQuotaTaskPreCountResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Query quota task pre-count |
| admin | GET | /v1/admin/marketing/quota/list |
QueryQuotaTaskListRequest |
QueryQuotaTaskListResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Query quota task list |
| admin | POST | /v1/admin/marketing/quota/status |
QueryQuotaTaskStatusRequest |
QueryQuotaTaskStatusResponse |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Query quota task status |
| admin | POST | /v1/admin/order |
CreateOrderRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create order;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | GET | /v1/admin/order/list |
GetOrderListRequest |
GetOrderListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get order list;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | PUT | /v1/admin/order/status |
UpdateOrderStatusRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update order status;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | POST | /v1/admin/order/refund |
RefundOrderRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Refund order;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | POST | /v1/admin/order/activate |
ActivateOrderRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Manually activate order;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | POST | /v1/admin/payment |
CreatePaymentMethodRequest |
PaymentConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create Payment Method;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | PUT | /v1/admin/payment |
UpdatePaymentMethodRequest |
PaymentConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update Payment Method;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | DELETE | /v1/admin/payment |
DeletePaymentMethodRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete Payment Method;订单/支付路径需沙箱网关与测试订单隔离;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/payment/list |
GetPaymentMethodListRequest |
GetPaymentMethodListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get Payment Method List;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | GET | /v1/admin/payment/platform |
- |
PlatformResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get supported payment platform;订单/支付路径需沙箱网关与测试订单隔离 |
| admin | POST | /v1/admin/promo/rule |
CreatePromoRuleRequest |
PromoRule |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create promo rule |
| admin | GET | /v1/admin/promo/rule/list |
GetPromoRuleListRequest |
GetPromoRuleListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get promo rule list |
| admin | GET | /v1/admin/promo/rule/:id |
GetPromoRuleDetailRequest |
PromoRule |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get promo rule detail |
| admin | PUT | /v1/admin/promo/rule/:id |
UpdatePromoRuleRequest |
PromoRule |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update promo rule |
| admin | DELETE | /v1/admin/promo/rule/:id |
DeletePromoRuleRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete promo rule;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | POST | /v1/admin/promo/price |
SetPromoPriceRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Set promo prices |
| admin | GET | /v1/admin/promo/price/list |
GetPromoPriceListRequest |
GetPromoPriceListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get promo price list |
| admin | DELETE | /v1/admin/promo/price/:id |
DeletePromoPriceRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete promo price;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/promo/usage/list |
GetPromoUsageListRequest |
GetPromoUsageListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get promo usage list |
| admin | POST | /v1/admin/redemption/code |
CreateRedemptionCodeRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create redemption code |
| admin | PUT | /v1/admin/redemption/code |
UpdateRedemptionCodeRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update redemption code |
| admin | PUT | /v1/admin/redemption/code/status |
ToggleRedemptionCodeStatusRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Toggle redemption code status |
| admin | DELETE | /v1/admin/redemption/code |
DeleteRedemptionCodeRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete redemption code;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | DELETE | /v1/admin/redemption/code/batch |
BatchDeleteRedemptionCodeRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Batch delete redemption code;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/redemption/code/list |
GetRedemptionCodeListRequest |
GetRedemptionCodeListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get redemption code list |
| admin | GET | /v1/admin/redemption/record/list |
GetRedemptionRecordListRequest |
GetRedemptionRecordListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get redemption record list |
| admin | POST | /v1/admin/server/create |
CreateServerRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create Server |
| admin | POST | /v1/admin/server/update |
UpdateServerRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update Server |
| admin | POST | /v1/admin/server/delete |
DeleteServerRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete Server;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/server/list |
FilterServerListRequest |
FilterServerListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter Server List |
| admin | GET | /v1/admin/server/protocols |
GetServerProtocolsRequest |
GetServerProtocolsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Server Protocols |
| admin | POST | /v1/admin/server/node/create |
CreateNodeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create Node |
| admin | POST | /v1/admin/server/node/update |
UpdateNodeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update Node |
| admin | POST | /v1/admin/server/node/delete |
DeleteNodeRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete Node;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/server/node/list |
FilterNodeListRequest |
FilterNodeListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Filter Node List |
| admin | POST | /v1/admin/server/node/status/toggle |
ToggleNodeStatusRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Toggle Node Status |
| admin | POST | /v1/admin/server/server/sort |
ResetSortRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reset server sort;状态变更操作,需隔离测试资源 |
| admin | POST | /v1/admin/server/node/sort |
ResetSortRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reset node sort;状态变更操作,需隔离测试资源 |
| admin | GET | /v1/admin/server/node/tags |
- |
QueryNodeTagResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Query all node tags |
| admin | POST | /v1/admin/subscribe/group |
CreateSubscribeGroupRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create subscribe group |
| admin | PUT | /v1/admin/subscribe/group |
UpdateSubscribeGroupRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update subscribe group |
| admin | GET | /v1/admin/subscribe/group/list |
- |
GetSubscribeGroupListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe group list |
| admin | DELETE | /v1/admin/subscribe/group |
DeleteSubscribeGroupRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete subscribe group;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | DELETE | /v1/admin/subscribe/group/batch |
BatchDeleteSubscribeGroupRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Batch delete subscribe group;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | POST | /v1/admin/subscribe |
CreateSubscribeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create subscribe |
| admin | PUT | /v1/admin/subscribe |
UpdateSubscribeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update subscribe |
| admin | GET | /v1/admin/subscribe/list |
GetSubscribeListRequest |
GetSubscribeListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe list |
| admin | DELETE | /v1/admin/subscribe |
DeleteSubscribeRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete subscribe;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | DELETE | /v1/admin/subscribe/batch |
BatchDeleteSubscribeRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Batch delete subscribe;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/subscribe/details |
GetSubscribeDetailsRequest |
Subscribe |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe details |
| admin | POST | /v1/admin/subscribe/sort |
SubscribeSortRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Subscribe sort |
| admin | POST | /v1/admin/subscribe/reset_all_token |
- |
ResetAllSubscribeTokenResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reset all subscribe tokens;状态变更操作,需隔离测试资源 |
| admin | GET | /v1/admin/system/site_config |
- |
SiteConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get site config |
| admin | PUT | /v1/admin/system/site_config |
SiteConfig |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update site config |
| admin | GET | /v1/admin/system/subscribe_config |
- |
SubscribeConfig |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get subscribe config |
| admin | PUT | /v1/admin/system/subscribe_config |
SubscribeConfig |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update subscribe config |
| admin | GET | /v1/admin/system/register_config |
- |
RegisterConfig |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get register config |
| admin | PUT | /v1/admin/system/register_config |
RegisterConfig |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update register config |
| admin | GET | /v1/admin/system/verify_config |
- |
VerifyConfig |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get verify config |
| admin | PUT | /v1/admin/system/verify_config |
VerifyConfig |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update verify config |
| admin | GET | /v1/admin/system/node_config |
- |
NodeConfig |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get node config |
| admin | PUT | /v1/admin/system/node_config |
NodeConfig |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update node config |
| admin | GET | /v1/admin/system/invite_config |
- |
InviteConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get invite config |
| admin | PUT | /v1/admin/system/invite_config |
InviteConfig |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update invite config |
| admin | GET | /v1/admin/system/tos_config |
- |
TosConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get Team of Service Config |
| admin | PUT | /v1/admin/system/tos_config |
TosConfig |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update Team of Service Config |
| admin | GET | /v1/admin/system/privacy |
- |
PrivacyPolicyConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: get Privacy Policy Config |
| admin | PUT | /v1/admin/system/privacy |
PrivacyPolicyConfig |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update Privacy Policy Config |
| admin | GET | /v1/admin/system/currency_config |
- |
CurrencyConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get Currency Config |
| admin | PUT | /v1/admin/system/currency_config |
CurrencyConfig |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update Currency Config |
| admin | POST | /v1/admin/system/setting_telegram_bot |
- |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: setting telegram bot;外部 OAuth/Telegram 依赖需 mock provider |
| admin | GET | /v1/admin/system/get_node_multiplier |
- |
GetNodeMultiplierResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Node Multiplier |
| admin | POST | /v1/admin/system/set_node_multiplier |
SetNodeMultiplierRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Set Node Multiplier |
| admin | GET | /v1/admin/system/verify_code_config |
- |
VerifyCodeConfig |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get Verify Code Config |
| admin | PUT | /v1/admin/system/verify_code_config |
VerifyCodeConfig |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update Verify Code Config |
| admin | GET | /v1/admin/system/signature_config |
- |
SignatureConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get Signature Config |
| admin | PUT | /v1/admin/system/signature_config |
SignatureConfig |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update Signature Config |
| admin | GET | /v1/admin/system/node_multiplier/preview |
- |
PreViewNodeMultiplierResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: PreView Node Multiplier |
| admin | GET | /v1/admin/system/module |
- |
ModuleConfig |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get Module Config |
| admin | GET | /v1/admin/ticket/list |
GetTicketListRequest |
GetTicketListResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get ticket list |
| admin | GET | /v1/admin/ticket/detail |
GetTicketRequest |
Ticket |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get ticket detail |
| admin | PUT | /v1/admin/ticket |
UpdateTicketStatusRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Update ticket status |
| admin | POST | /v1/admin/ticket/follow |
CreateTicketFollowRequest |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Create ticket follow |
| admin | GET | /v1/admin/tool/log |
- |
LogResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get System Log |
| admin | GET | /v1/admin/tool/restart |
- |
- |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Restart System |
| admin | GET | /v1/admin/tool/version |
- |
VersionResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Get Version |
| admin | GET | /v1/admin/tool/ip/location |
QueryIPLocationRequest |
QueryIPLocationResponse |
是(AuthMiddleware) | P1 | 中间件: AuthMiddleware;doc: Query IP Location |
| admin | GET | /v1/admin/user/list |
GetUserListRequest |
GetUserListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user list |
| admin | GET | /v1/admin/user/detail |
GetDetailRequest |
User |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user detail |
| admin | PUT | /v1/admin/user/basic |
UpdateUserBasiceInfoRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update user basic info |
| admin | PUT | /v1/admin/user/notify |
UpdateUserNotifySettingRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Update user notify setting |
| admin | DELETE | /v1/admin/user |
GetDetailRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete user;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/user/current |
- |
User |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Current user |
| admin | DELETE | /v1/admin/user/batch |
BatchDeleteUserRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Batch delete user;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | POST | /v1/admin/user |
CreateUserRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create user |
| admin | PUT | /v1/admin/user/device |
UserDevice |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: User device |
| admin | DELETE | /v1/admin/user/device |
DeleteUserDeivceRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete user device;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | PUT | /v1/admin/user/device/kick_offline |
KickOfflineRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: kick offline user device;状态变更操作,需隔离测试资源 |
| admin | POST | /v1/admin/user/auth_method |
CreateUserAuthMethodRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create user auth method |
| admin | DELETE | /v1/admin/user/auth_method |
DeleteUserAuthMethodRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete user auth method;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | PUT | /v1/admin/user/auth_method |
UpdateUserAuthMethodRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update user auth method |
| admin | GET | /v1/admin/user/auth_method |
GetUserAuthMethodRequest |
GetUserAuthMethodResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user auth method |
| admin | GET | /v1/admin/user/subscribe |
GetUserSubscribeListRequest |
GetUserSubscribeListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user subcribe |
| admin | GET | /v1/admin/user/subscribe/detail |
GetUserSubscribeByIdRequest |
UserSubscribeDetail |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user subcribe by id |
| admin | GET | /v1/admin/user/subscribe/logs |
GetUserSubscribeLogsRequest |
GetUserSubscribeLogsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user subcribe logs |
| admin | GET | /v1/admin/user/subscribe/reset/logs |
GetUserSubscribeResetTrafficLogsRequest |
GetUserSubscribeResetTrafficLogsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user subcribe reset traffic logs;状态变更操作,需隔离测试资源 |
| admin | GET | /v1/admin/user/subscribe/traffic_logs |
GetUserSubscribeTrafficLogsRequest |
GetUserSubscribeTrafficLogsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user subcribe traffic logs |
| admin | GET | /v1/admin/user/subscribe/device |
GetUserSubscribeDevicesRequest |
GetUserSubscribeDevicesResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user subcribe devices |
| admin | POST | /v1/admin/user/subscribe |
CreateUserSubscribeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Create user subcribe |
| admin | PUT | /v1/admin/user/subscribe |
UpdateUserSubscribeRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update user subcribe |
| admin | DELETE | /v1/admin/user/subscribe |
DeleteUserSubscribeRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Delete user subcribe;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | GET | /v1/admin/user/login/logs |
GetUserLoginLogsRequest |
GetUserLoginLogsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get user login logs |
| admin | POST | /v1/admin/user/subscribe/reset/token |
ResetUserSubscribeTokenRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reset user subscribe token;状态变更操作,需隔离测试资源 |
| admin | POST | /v1/admin/user/subscribe/toggle |
ToggleUserSubscribeStatusRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Stop user subscribe |
| admin | POST | /v1/admin/user/subscribe/reset/traffic |
ResetUserSubscribeTrafficRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reset user subscribe traffic;状态变更操作,需隔离测试资源 |
| admin | GET | /v1/admin/user/family/list |
GetFamilyListRequest |
GetFamilyListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get family list |
| admin | GET | /v1/admin/user/family/detail |
GetFamilyDetailRequest |
FamilyDetail |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get family detail |
| admin | PUT | /v1/admin/user/family/max_members |
UpdateFamilyMaxMembersRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Update family max members |
| admin | PUT | /v1/admin/user/family/member/remove |
RemoveFamilyMemberRequest |
- |
是(AuthMiddleware) | P2 | 中间件: AuthMiddleware;doc: Remove family member;破坏性操作,需专用测试数据并校验回滚/幂等 |
| admin | PUT | /v1/admin/user/family/dissolve |
DissolveFamilyRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Dissolve family |
| admin | GET | /v1/admin/user/withdrawal/list |
GetWithdrawalListRequest |
GetWithdrawalListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get withdrawal list;提现路径影响资金数据,需专用测试账号 |
| admin | POST | /v1/admin/user/withdrawal/approve |
ApproveWithdrawalRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Approve withdrawal;提现路径影响资金数据,需专用测试账号 |
| admin | POST | /v1/admin/user/withdrawal/reject |
RejectWithdrawalRequest |
- |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Reject withdrawal;提现路径影响资金数据,需专用测试账号 |
| admin | GET | /v1/admin/user/invite/stats |
GetAdminUserInviteStatsRequest |
GetAdminUserInviteStatsResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get admin user invite stats |
| admin | GET | /v1/admin/user/invite/list |
GetAdminUserInviteListRequest |
GetAdminUserInviteListResponse |
是(AuthMiddleware) | P0 | 中间件: AuthMiddleware;doc: Get admin user invite list |
node Endpoints
| Domain | Method | Path | Request Type | Response Type | Auth | Priority | Notes |
|---|---|---|---|---|---|---|---|
| node | GET | /v1/server/user |
GetServerUserListRequest |
GetServerUserListResponse |
是(ServerMiddleware/secret_key) | P0 | 中间件: ServerMiddleware;doc: Get user list;节点接口依赖 server_id/secret_key 测试夹具 |
| node | POST | /v1/server/push |
ServerPushUserTrafficRequest |
- |
是(ServerMiddleware/secret_key) | P0 | 中间件: ServerMiddleware;doc: Push user Traffic;节点接口依赖 server_id/secret_key 测试夹具 |
| node | POST | /v1/server/status |
ServerPushStatusRequest |
- |
是(ServerMiddleware/secret_key) | P0 | 中间件: ServerMiddleware;doc: Push server status;节点接口依赖 server_id/secret_key 测试夹具 |
| node | GET | /v1/server/config |
GetServerConfigRequest |
GetServerConfigResponse |
是(ServerMiddleware/secret_key) | P0 | 中间件: ServerMiddleware;doc: Get server config;节点接口依赖 server_id/secret_key 测试夹具 |
| node | POST | /v1/server/online |
OnlineUsersRequest |
- |
是(ServerMiddleware/secret_key) | P0 | 中间件: ServerMiddleware;doc: Push online users;节点接口依赖 server_id/secret_key 测试夹具 |
| node | GET | /v2/server/:server_id |
QueryServerConfigRequest |
QueryServerConfigResponse |
否 | P0 | doc: Get Server Protocol Config;节点接口依赖 server_id/secret_key 测试夹具 |