应用管理
应用是一套独立的 IM 环境:IM 用户、好友、群组、聊天室、消息和文件都属于某个应用,不同应用之间的数据完全隔离。每个应用有自己的 AppKey、服务端凭据、IP 白名单、运行策略和套餐。建议为测试环境和生产环境分别创建应用。
在菜单“应用”中查看租户的全部应用,可以按状态(正常、已停用)筛选。所有成员都能查看应用,创建、修改、停用和删除应用需要 owner 或 admin。
创建应用
在“应用”页点击右上角的“创建应用”,填写:
| 字段 | 说明 |
|---|---|
| 应用名(app_name) | 应用的标识:以小写字母开头,由小写字母、数字和 - 组成,3 到 32 个字符,如 demo、chat-prod。在租户内唯一,创建后不能修改,删除后也不能再次使用 |
| 显示名称 | 便于识别的名称,最多 128 个字符,之后可以修改 |
| 描述 | 可选,最多 512 个字符 |
| 客户端注册 | 是否允许用户在客户端自己注册,默认关闭,见下文的客户端注册 |
应用创建在租户的默认区域(在“概览”页的租户信息中修改)。每个租户最多有 10 个应用(已删除的不计),需要更多时请先完成企业认证。
新应用自动使用平台的默认套餐,从创建当天开始计费,见套餐与账单。
创建成功后,页面显示应用的 app_key 和第一组服务端凭据:
- app_key:客户端登录时使用,见下文的 AppKey;
- client_id 和 client_secret:业务服务端用它们换取 App Token。client_secret 只显示这一次,请立即保存到服务端的密钥管理系统中,然后点击“我已保存密钥,进入应用”。
忘记保存 client_secret 时,可以在应用的“服务端密钥”中轮换出一个新的,见服务端凭据与 IP 白名单。
AppKey
AppKey 由租户的 org_name 和应用的 app_name 用 # 连接而成,创建后立即可用,不会改变:
1100250925#demo
└── org_name ┘└ app_name客户端登录时使用 AppKey;服务端 REST API 的地址中分别使用两部分,如 https://api.example.com/1100250925/demo/users,见接入概述。应用列表和应用详情页的顶部都可以复制 app_key。
客户端注册
“客户端注册”决定 IM 用户可以由谁创建:
| 选项 | 取值 | 说明 |
|---|---|---|
| 关闭(默认) | authorized | 只能由你的业务服务端调用创建用户接口,或在控制台中创建 IM 用户。用户只能使用你允许的账号,适合正式环境 |
| 开放 | open | 用户还可以在客户端自己注册账号,任何拿到 AppKey 的人都能注册。只建议在测试应用中使用 |
应用详情
在应用列表中点击应用名称进入应用详情。顶部显示显示名称、app_name、状态和 app_key,下方有以下标签页:
| 标签页 | 内容 |
|---|---|
| 概览与设置 | 用户数和连接统计、应用信息,修改、停用和删除应用 |
| IM 用户、群组、消息、聊天室 | 管理应用中的数据,见用户、群组、聊天室与消息 |
| 音视频 | 音视频的可用状态、通话统计和通话列表,结束通话,见音视频 |
| 文件存储 | 存储用量,查看、下载、删除和上传文件,见文件存储 |
| 推送 | 推送凭据、通知模板和推送统计,见推送配置 |
| 回调 | 回调地址、同步回调和事件目录,见回调配置 |
| 内容安全 | 内容安全的配置、词库、审核记录、平台处置、用户违规和统计,见内容安全配置 |
| 应用策略 | 本应用的运行策略,见运行策略 |
| 套餐与用量 | 当前的套餐、额度、套餐变更历史和每日用量,见应用的套餐与用量 |
| 服务端密钥、IP 白名单 | 见服务端凭据与 IP 白名单 |
“概览与设置”中的应用信息:
| 项目 | 说明 |
|---|---|
| 显示名称、描述 | 可以修改 |
| app_id | 应用 ID,换取 App Token 的响应中的 application 就是它 |
| 客户端注册 | 开放或关闭,可以修改 |
| 区域 | 应用的数据所在的区域,创建后不能修改 |
| 套餐档位、每分钟消息数上限 | 平台为应用设置的保护性配额,只读,见配额与熔断。“套餐档位”与计费的套餐无关 |
| 创建时间 | 应用的创建时间 |
顶部的用户数和连接统计见用户、群组、聊天室与消息。
修改应用
owner 和 admin 在“概览与设置”中点击“修改”,可以修改显示名称、描述和客户端注册。app_name、区域不能修改。
把客户端注册由开放改为关闭后,客户端不能再注册新用户,已经注册的用户不受影响。
停用与启用
暂时不想让应用提供服务时(如测试应用暂不使用、发现凭据泄露),可以停用应用。owner 和 admin 在“概览与设置”中点击“停用应用”:
- 应用已签发的 App Token 和 User Token 立即全部失效,在线的客户端被断开;
- 服务端用原来的 App Token 调用 OpenAPI 返回
401 unauthenticated,重新换取 App Token 返回403 app_unavailable;客户端不能登录; - 应用的数据全部保留。控制台中照常可以修改应用、管理服务端密钥、IP 白名单和应用策略;
- 停用期间应用照常计费,见计费规则。
点击“启用应用”后恢复服务。服务端需要重新换取 App Token;客户端续期令牌即可继续使用,不必重新登录,但停用时间超过登录有效期(默认 7 天)的用户需要重新登录。
删除应用
owner 和 admin 在“概览与设置”中点击“删除应用”,确认后重新验证身份。
- 应用立即从控制台中消失,已签发的全部令牌失效,在线的客户端被断开;
- 应用的全部 IM 用户、好友、群组、消息和文件由后台分批永久删除;
- 之前签发的 App Token 调用 OpenAPI 返回
401 unauthenticated,details.reason为app_deleted,服务端应据此清除保存的凭据、不再重试; - 这个
app_name不能再用于创建新应用,避免仍在使用旧 AppKey 的客户端连到新应用; - 删除当天是应用的最后一个计费日。
删除不能恢复
删除后数据无法找回,app_name 也不能再使用。如果只是暂时不用,请停用应用。
配额与熔断
应用能使用的资源有两类上限:
- 套餐的额度:注册用户数、并发连接数、群总数、每个群的人数、存储容量、并发通话数、聊天室数等数量上限由应用的套餐决定,在“套餐与用量”中查看,见额度;
- 保护性配额:平台为每个应用设置的一组配额,防止异常流量影响服务,如每分钟的消息数、每秒的请求数。
控制台的“概览与设置”中显示保护性配额中的两项,只能查看,不能修改:
| 项目 | 说明 |
|---|---|
| 套餐档位 | 平台为应用标记的保护性配额的档位,默认为 standard。它只是一个标签,各项配额的数值以平台的设置为准,与计费的套餐无关 |
| 每分钟消息数上限 | 应用每分钟最多发送的消息条数,默认 30000。客户端和服务端发送的消息都计入,服务端批量发送按接收人数计入。超出时发送返回 429 rate_limited |
存储容量和聊天室数在保护性配额中也各有一项(存储默认 1024 GB,聊天室默认 1 万个),实际取配额与套餐的额度中较小的一个。应用的存储额度显示在“文件存储”的存储用量中,用满后不能再上传新文件。
另外,服务端 OpenAPI 和客户端接口也各有每秒的请求数上限,超出时返回 429 rate_limited。在应用流量异常时,平台还可能对应用限流、设为只读(用户可以登录和查看,不能发送消息和修改数据)或暂停服务。这些限制的具体规则和错误码见限流与应用状态。需要更多的用户数、连接数、存储容量等额度时,请更换套餐;需要提高每分钟消息数等保护性配额时,请联系我们。
RTC 频道入口
应用详情的“RTC 频道”提供频道、成员、会话、统计及更正查询,以及允许角色的处置操作,见RTC 频道管理。它与“音视频”中的原通话列表分开;开放频道数和媒体并发额度是不同上限。
