# ShangCloud

## Docs
- [ShangCloud简介](https://doc.yearnstudio.cn/doc-5325261.md): 
- [立项一周年庆祝](https://doc.yearnstudio.cn/doc-7248348.md): 
- v3 [V3设计理念](https://doc.yearnstudio.cn/doc-7118386.md): 
- v3 [扩展使用教程](https://doc.yearnstudio.cn/doc-8197986.md): 
- v3 [数据导出](https://doc.yearnstudio.cn/doc-9235122.md): 
- v3 > 云函数 [云函数初步设计 - ShangCloud](https://doc.yearnstudio.cn/doc-9212711.md): 关于ShangClloud云函数的初步设计草案
- v3 > 云函数 [使用指南](https://doc.yearnstudio.cn/doc-9280099.md): 
- v3 > 社区作品ID获取教程 [40code](https://doc.yearnstudio.cn/doc-8736193.md): 
- v3 > 社区作品ID获取教程 [ZeroCat (Moonrend)](https://doc.yearnstudio.cn/doc-8736194.md): 
- v3 > 社区作品ID获取教程 [CCW(共创世界)](https://doc.yearnstudio.cn/doc-8736195.md): 
- v3 > 社区作品ID获取教程 [AstraEditor & 02engine & Bilup](https://doc.yearnstudio.cn/doc-8917722.md): 
- v3 > OAuth [设备授权登录](https://doc.yearnstudio.cn/doc-9232484.md): 
- v3 > MMO联机 [说明](https://doc.yearnstudio.cn/doc-7132636.md): 
- v3 > MMO联机 [TCP/UDP协议联机](https://doc.yearnstudio.cn/doc-8852204.md): 
- v3 > Q&A [40code作品绑定教程](https://doc.yearnstudio.cn/doc-8320615.md): 
- v3 > Q&A [ZeroCat作品绑定教程](https://doc.yearnstudio.cn/doc-8320618.md): 
- v3 > Q&A [时间同步](https://doc.yearnstudio.cn/doc-8736200.md): 
- v3 > Q&A [初始化失败 - 未绑定作品](https://doc.yearnstudio.cn/doc-8736241.md): 
- v3 > Q&A [AstraEditor & 02engine & Bilup](https://doc.yearnstudio.cn/doc-8917723.md): 
- v2 [v2](https://doc.yearnstudio.cn/doc-5461935.md): 
- v1 [v1](https://doc.yearnstudio.cn/doc-5461911.md): 
- MMO [接入文档](https://doc.yearnstudio.cn/doc-8508949.md): 

## API Docs
- v3 > 云变量 [用户变量操作 (读/写/删)](https://doc.yearnstudio.cn/api-469444667.md): 通用的 JSON POST 请求工具函数，根据不同的 action 对用户的键值对变量进行读取、写入或删除操作。
- v3 > 云函数 [调用主节点云函数](https://doc.yearnstudio.cn/api-497105512.md): 同步调用指定应用中已启用的主节点云函数。
- v3 > OAuth [获取或刷新 AccessToken](https://doc.yearnstudio.cn/api-327108664.md): 支持以下授权类型：
- v3 > MMO联机 [创建房间](https://doc.yearnstudio.cn/api-475695436.md): 创建房间。调用者自动成为房主并加入房间。
- v3 > MMO联机 [加入已有房间](https://doc.yearnstudio.cn/api-475695437.md): 加入已有房间。每次调用生成独立的 connect_key，支持同一用户多标签页连接。
- v3 > MMO联机 [设置房间配置](https://doc.yearnstudio.cn/api-475695438.md): 设置房间配置。仅房主可操作。
- v3 > MMO联机 [设置房间额外数据（键值对）](https://doc.yearnstudio.cn/api-475695439.md): 设置房间额外数据（键值对）。仅房主可操作。
- v3 > MMO联机 [获取房间所有额外数据](https://doc.yearnstudio.cn/api-475695440.md): 获取房间所有额外数据。
- v3 > MMO联机 [删除房间额外数据中的指定键](https://doc.yearnstudio.cn/api-475695441.md): 删除房间额外数据中的指定键。仅房主可操作。
- v3 > MMO联机 [强制踢出房间内指定用户](https://doc.yearnstudio.cn/api-475695442.md): 强制踢出房间内指定用户。仅房主可操作，房主不能踢出自己。
- v3 > MMO联机 [查询指定房间的当前人数](https://doc.yearnstudio.cn/api-475695443.md): 查询指定房间的当前人数。只能查询与 token 所属应用相同的房间。
- v3 > 即时通讯 > 会话 [获取会话列表](https://doc.yearnstudio.cn/api-497197375.md): 返回授权用户当前可见的会话，按最近变化排序。结果可能包含授权前以及其他
- v3 > 即时通讯 > 会话 [获取会话详情](https://doc.yearnstudio.cn/api-497197376.md): 
- v3 > 即时通讯 > 会话 [获取当前会话成员](https://doc.yearnstudio.cn/api-497197377.md): 返回当前可见成员的公开资料和会话角色，不返回邮箱或绑定账号等资料。
- v3 > 即时通讯 > 消息 [获取历史消息](https://doc.yearnstudio.cn/api-497197378.md): 从最新一页向过去分页读取。`before` 是排他的消息 ID 边界；省略或传 0
- v3 > 即时通讯 > 消息 [发送文本消息或回复](https://doc.yearnstudio.cn/api-497197379.md): 以授权用户身份发送纯文本消息。提供 `reply_to_id` 时发送回复，目标消息
- v3 > 即时通讯 > 消息 [获取历史消息（兼容路径）](https://doc.yearnstudio.cn/api-497197380.md): 与 `GET /conversations/{conversation_id}/messages` 完全相同。
- v3 > 即时通讯 > 消息 [回复指定消息](https://doc.yearnstudio.cn/api-497197381.md): 回复路径中的消息。请求体中的 `reply_to_id` 或 `reply_to_message_id` 会被忽略，
- v3 > 即时通讯 > 消息 [编辑文本消息](https://doc.yearnstudio.cn/api-497197382.md): 只能编辑由当前应用代当前授权用户发送、状态正常且发送时间不超过 15 分钟的
- v3 > 即时通讯 > 消息 [仅为自己删除消息](https://doc.yearnstudio.cn/api-497197383.md): 从授权用户自己的列表、历史和后续同步中隐藏消息，不影响其他成员看到的内容。
- v3 > 即时通讯 > 消息 [撤回消息](https://doc.yearnstudio.cn/api-497197384.md): 撤回对所有参与者生效，并留下撤回状态。只能撤回由当前应用代当前授权用户发送、
- v3 > 即时通讯 > 已读状态 [获取自己的已读状态](https://doc.yearnstudio.cn/api-497197385.md): 
- v3 > 即时通讯 > 已读状态 [推进自己的已读位置](https://doc.yearnstudio.cn/api-497197386.md): 已读位置只能单调向前推进，重复提交是幂等的。省略 `last_id` 或传 `null`
- v3 > 即时通讯 > 已读状态 [获取自己的已读状态（兼容路径）](https://doc.yearnstudio.cn/api-497197387.md): 与 `GET /conversations/{conversation_id}/read` 完全相同。
- v3 > 即时通讯 > 已读状态 [推进自己的已读位置（兼容路径）](https://doc.yearnstudio.cn/api-497197388.md): 与 `POST /conversations/{conversation_id}/read` 完全相同。
- v3 > 即时通讯 > 同步 [增量同步会话和消息变化](https://doc.yearnstudio.cn/api-497197389.md): 首次同步传 `since: 0`，游标映射可省略或传空对象。后续请求应完整回传上次
- v3 > 娱乐功能 [随机图](https://doc.yearnstudio.cn/api-329288024.md): 获取一张随机图
- v3 > 扩展API [QQ消息推送](https://doc.yearnstudio.cn/api-369366683.md): 内测功能，目前不对外开放，后续可能会考虑开放。
- v3 > 扩展API [群推送接口](https://doc.yearnstudio.cn/api-373761842.md): 内部使用接口
- v3 > 扩展API [IP查询](https://doc.yearnstudio.cn/api-458690670.md): 来自于多个数据库的IP位置API, 直接返回地址字符串
- v3 > 健康监控 [平台存活状态](https://doc.yearnstudio.cn/api-432670223.md): 轻量级心跳接口，返回平台版本和累计请求数。
- v3 > 健康监控 [MMO 系统状态](https://doc.yearnstudio.cn/api-432670224.md): 返回 MMO 多人联机系统的聚合状态，包括节点数量、在线用户、活跃房间和大厅数量。
- v3 > 健康监控 [平台统计数据](https://doc.yearnstudio.cn/api-432670225.md): 返回平台核心统计数据，包括注册用户总量、今日登录人数、活跃应用数和扩展使用量。
- v2 > 账号操作 [登陆](https://doc.yearnstudio.cn/api-219133107.md): 通过json请求body进行登陆
- v2 > 账号操作 [获取用户信息](https://doc.yearnstudio.cn/api-257573017.md): 
- v2 > 账号操作 [绑定40code账户](https://doc.yearnstudio.cn/api-257573251.md): 
- v2 > 数据库部分 [新建数据库](https://doc.yearnstudio.cn/api-229493946.md): v2版本新建数据库
- v2 > 数据库部分 [删除数据库](https://doc.yearnstudio.cn/api-225617238.md): 删除指定用户的指定数据库v2
- v2 > 数据库部分 [读取数据库](https://doc.yearnstudio.cn/api-229495762.md): v2版本读取数据库
- v2 > 数据库部分 [写入数据库](https://doc.yearnstudio.cn/api-229491526.md): 
- v2 > 数据库部分 [获取数据库列表](https://doc.yearnstudio.cn/api-229493069.md): v2版本获取数据库列表
- v2 > 数据库部分 [重置数据库](https://doc.yearnstudio.cn/api-229497370.md): 
- v2 > 状态获取 [服务器总占用](https://doc.yearnstudio.cn/api-229843705.md): 服务器数据目录总占用(单位：字符个数)
- v1 > 账号操作 > 管理员 [创建新用户](https://doc.yearnstudio.cn/api-193750447.md): 
- v1 > 账号操作 > 管理员 [删除用户](https://doc.yearnstudio.cn/api-193751175.md): 删除指定的用户
- v1 > 账号操作 > 管理员 [设置管理员](https://doc.yearnstudio.cn/api-210646858.md): 设置/取消设置管理员，要求登录用户必须具有管理员权限
- v1 > 账号操作 > 管理员 [获取用户列表](https://doc.yearnstudio.cn/api-215787563.md): 获取所有用户列表
- v1 > 账号操作 > 管理员 [封禁用户](https://doc.yearnstudio.cn/api-215787904.md): 封禁指定用户
- v1 > 账号操作 > 管理员 [解封用户](https://doc.yearnstudio.cn/api-215787914.md): 解除封禁指定用户
- v1 > 账号操作 > 普通用户 [登录](https://doc.yearnstudio.cn/api-193728042.md): 登录接口
- v1 > 账号操作 > 普通用户 [更改密码](https://doc.yearnstudio.cn/api-193731445.md): 更改登录用户的密码为指定的密码
- v1 > 账号操作 > 游客 [获取用户状态](https://doc.yearnstudio.cn/api-215787743.md): 获取用户属于的用户组/封禁状态
- v1 > 账号操作 > 游客 [注册](https://doc.yearnstudio.cn/api-215787975.md): 注册新用户
- v1 > API部分 [获取时间戳](https://doc.yearnstudio.cn/api-193731715.md): 获取服务器时间戳
- v1 > API部分 [获取版本号](https://doc.yearnstudio.cn/api-193731888.md): 获取当前服务器版本
- v1 > API部分 [邮件验证码](https://doc.yearnstudio.cn/api-205931192.md): 向<mail>发送验证码，并返回发送的验证码
- v1 > API部分 [发送HTTP请求](https://doc.yearnstudio.cn/api-205931781.md): 向指定的url发送HTTP请求，并返回结果
- v1 > 数据库部分 [新建数据库](https://doc.yearnstudio.cn/api-193752185.md): 创建新数据库
- v1 > 数据库部分 [删除数据库](https://doc.yearnstudio.cn/api-194077366.md): 删除指定用户的指定数据库
- v1 > 数据库部分 [读取数据库](https://doc.yearnstudio.cn/api-194093765.md): 读取指定用户的指定数据库的指定键的对应数据
- v1 > 数据库部分 [写入数据库](https://doc.yearnstudio.cn/api-194108110.md): 向指定的用户的指定数据库中的指定键写入指定数据
- v1 > 数据库部分 [更改数据库权限](https://doc.yearnstudio.cn/api-205984400.md): 更改指定数据库权限(登录用户需要具有数据库的control权限，自己的数据库可以直接操作)
- v1 > 数据库部分 [获取数据库列表](https://doc.yearnstudio.cn/api-215787864.md): 获取自己的数据库列表
- v1 > 服务器状态 [获取CPU占用](https://doc.yearnstudio.cn/api-215796839.md): 获取服务器当前CPU占用
- v1 > 服务器状态 [获取总内存](https://doc.yearnstudio.cn/api-215796849.md): 获取服务器总内存(单位:GB)
- v1 > 服务器状态 [获取使用中内存](https://doc.yearnstudio.cn/api-215796853.md): 获取服务器已使用内存(单位:GB)
- v1 > 服务器状态 [获取指定硬盘总容量](https://doc.yearnstudio.cn/api-215796861.md): 获取服务器指定硬盘的总容量
- v1 > 服务器状态 [获取指定硬盘使用容量](https://doc.yearnstudio.cn/api-215796874.md): 获取服务器指定硬盘的已使用容量(单位:GB)
- v1 > 服务器状态 [获取内存占用率](https://doc.yearnstudio.cn/api-215796857.md): 获取服务器当前内存占用率
- v1 > 服务器状态 [获取指定硬盘占用率](https://doc.yearnstudio.cn/api-215796903.md): 获取服务器指定硬盘占用率
- v1 > 服务器状态 [设置风扇转速](https://doc.yearnstudio.cn/api-215796922.md): 向iBMC发送风扇控制指令，设置风扇大小为指定值(通过putty)
- v1 > 服务器状态 [设置风扇为手动模式](https://doc.yearnstudio.cn/api-215797434.md): 通过iBMC设置风扇为手动模式
- v1 > 服务器状态 [服务器总状态](https://doc.yearnstudio.cn/api-219096513.md): 获取服务所有状态(包括CPU、内存、C盘)
- MMO [加入MMO房间](https://doc.yearnstudio.cn/api-441970861.md): 加入一个已存在的 MMO 房间。同一账号多端加入时会分配临时 UID（`assigned_uid`）。
- MMO [创建MMO房间](https://doc.yearnstudio.cn/api-441970860.md): 创建一个新的 MMO 房间，系统自动选择负载最低的边缘节点。
- [所有操作](https://doc.yearnstudio.cn/api-193720282.md): 默认登录接口，允许直接携带指令进行操作

## Schemas
- Schemas [AccessTokenInvalid](https://doc.yearnstudio.cn/schema-187622453.md): 
- Schemas [SuccessResponse](https://doc.yearnstudio.cn/schema-187423013.md): 
- Schemas [BadResponse](https://doc.yearnstudio.cn/schema-187423014.md): 
- Schemas [NoPowerResponse](https://doc.yearnstudio.cn/schema-187423015.md): 
- Schemas [NotFoundResponse](https://doc.yearnstudio.cn/schema-187423016.md): 
- Schemas [ServerErrorResponse](https://doc.yearnstudio.cn/schema-187423017.md): 
- [极验数据](https://doc.yearnstudio.cn/schema-249007697.md): 
- [RoomResult](https://doc.yearnstudio.cn/schema-263236156.md): 
- [VariableResponse](https://doc.yearnstudio.cn/schema-282190679.md): 
- [StatusResponse](https://doc.yearnstudio.cn/schema-257020504.md): 
- [ErrorResponse](https://doc.yearnstudio.cn/schema-257020507.md): 
- [InvokeSuccess](https://doc.yearnstudio.cn/schema-301350872.md): 
- [Error](https://doc.yearnstudio.cn/schema-263236157.md): 
- [MmoStatsResponse](https://doc.yearnstudio.cn/schema-257020505.md): 
- [UserSummary](https://doc.yearnstudio.cn/schema-301408673.md): 
- [SuccessStatusResponse](https://doc.yearnstudio.cn/schema-286545582.md): 
- [PlatformStatsResponse](https://doc.yearnstudio.cn/schema-257020506.md): 
- [ConversationMember](https://doc.yearnstudio.cn/schema-301408674.md): 
- [AppTitle](https://doc.yearnstudio.cn/schema-301408675.md): 
- [Attachment](https://doc.yearnstudio.cn/schema-301408676.md): 
- [ReplyReference](https://doc.yearnstudio.cn/schema-301408677.md): 
- [Message](https://doc.yearnstudio.cn/schema-301408678.md): 
- [Conversation](https://doc.yearnstudio.cn/schema-301408679.md): 
- [ConversationSummary](https://doc.yearnstudio.cn/schema-301408680.md): 
- [ChangedConversation](https://doc.yearnstudio.cn/schema-301408681.md): 
- [CursorPair](https://doc.yearnstudio.cn/schema-301408682.md): 
- [MessageCursorMap](https://doc.yearnstudio.cn/schema-301408683.md): 
- [PairCursorMap](https://doc.yearnstudio.cn/schema-301408684.md): 
- [SendMessageRequest](https://doc.yearnstudio.cn/schema-301408685.md): 
- [ReplyMessageRequest](https://doc.yearnstudio.cn/schema-301408686.md): 
- [EditMessageRequest](https://doc.yearnstudio.cn/schema-301408687.md): 
- [UpdateReadStateRequest](https://doc.yearnstudio.cn/schema-301408688.md): 
- [SyncRequest](https://doc.yearnstudio.cn/schema-301408689.md): 
- [ConversationListData](https://doc.yearnstudio.cn/schema-301408690.md): 
- [MemberListData](https://doc.yearnstudio.cn/schema-301408691.md): 
- [HistoryData](https://doc.yearnstudio.cn/schema-301408692.md): 
- [ReadStateData](https://doc.yearnstudio.cn/schema-301408693.md): 
- [DeleteMessageData](https://doc.yearnstudio.cn/schema-301408694.md): 
- [RecallMessageData](https://doc.yearnstudio.cn/schema-301408695.md): 
- [SyncData](https://doc.yearnstudio.cn/schema-301408696.md): 
- [ConversationListResponse](https://doc.yearnstudio.cn/schema-301408697.md): 
- [ConversationResponse](https://doc.yearnstudio.cn/schema-301408698.md): 
- [MemberListResponse](https://doc.yearnstudio.cn/schema-301408699.md): 
- [HistoryResponse](https://doc.yearnstudio.cn/schema-301408700.md): 
- [ReadStateResponse](https://doc.yearnstudio.cn/schema-301408701.md): 
- [MessageResponse](https://doc.yearnstudio.cn/schema-301408702.md): 
- [DeleteMessageResponse](https://doc.yearnstudio.cn/schema-301408703.md): 
- [RecallMessageResponse](https://doc.yearnstudio.cn/schema-301408704.md): 
- [SyncResponse](https://doc.yearnstudio.cn/schema-301408705.md): 
- [SuccessEnvelope](https://doc.yearnstudio.cn/schema-301408706.md):