新手入门

¶ 百川平台新手入门

百川平台的通用功能主要分以下六个模块

注册与登录

工作台

API Token使用

消息通知

空间管理

¶ 注册与登录

在开始使用长亭百川云服务之前，您需要先注册一个百川云账号。拥有账号后，您可以在百川云登录，从而选购和使用您需要的云产品和服务。

注册账号

访问百川云账号注册页面

使用已有第三方账号快捷注册。

微信操作

在移动端，打开微信扫一扫，扫描注册页面上的二维码。

在微信操作页，点击确认授权。

注册完成后，系统会自动创建一个属于您的组织。

登录账号

访问百川云账号登录页面

登录方式：

邮箱账号

a.输入您注册百川云账号时使用的邮箱及密码。

b.单击登录，即可登录。

微信账号

a.点击登录框下方的微信图标。

b.在移动端，打开微信扫一扫，扫描页面的二维码。

c.在微信中，确认账号信息，点击同意，即可登录。

¶ 工作台

百川云工作台是用于管理百川云产品的Web应用程序，提供了直观的图形化用户界面。在工作台，您可以进行以下操作。

开通产品应用

工作台为所有云产品提供了入口。一般情况下，您需要先开通一个云产品，才能访问该云产品的控制台并管理该云产品。

登录百川云

登录成功后，页面自动跳转（您最后访问的）组织的工作台，然后在产品市场，找到您需要的云产品，例如：网页监测。

鼠标悬浮在网页监测，点击"开始使用"，即可访问网页监测控制台进行使用。

查看已开通产品

为方便后续访问，已开通的产品将自动被添加至快捷入口。访问工作台-我的产品。

前往当前空间

空间是百川云中所有资源的载体，云产品、主机、文件、日志等数据资源依附于组织而存在，这些资源在空间范围内处于共享状态，空间内有相关权限的成员均可以访问这些资源。

¶ API Token使用

对于需要调用百川平台应用的接口进行二次开发的用户，百川平台提供了API Token的接入方式。API Token的生成是在百川平台，包含了权限、过期时间、名称等信息。使用API Token调用应用接口需要在header中带上X-Ca-Token字段。

¶ 生成

进入百川工作台，再进入组织管理界面，选择【API Token】，如下图所示

点击【生成API TOKEN】按钮

填入名称、权限、过期时间信息，点击【生成API TOKEN】，生成成功会弹出token信息，需要用户记录下该token值

选择权限：根据应用API需要的权限进行配置

¶ 使用

API Token的使用和应用的API相关，在请求应用接口的时候，需要在请求头中带上X-Ca-Token。假设牧云主机管理助手有下面接口

https://collie.rivers.chaitin.cn/api/v1/host/list

那么使用API Token的请求方式如下

curl -H 'X-Ca-Token:' https://collie.rivers.chaitin.cn/api/v1/host/list

¶ 消息通知

消息通知模块包含了站内通知、站外通知两个主要的功能，目前可以接收到来自平台的消息以及应用的消息，后续会逐渐增加其他消息来源。用户还可以自定义要接受通知的组织、以及应用，可以选择常用的接收渠道进行转发（目前可配置的站外渠道包括：邮箱、微信、企业微信、钉钉、飞书）

¶ 消息通知入口

消息通知入口位于页面右上角的铃铛图标处，依次点击“铃铛 > 查看全部” 后可看到个人消息历史界面以及消息转发设置界面，如下图：

¶ 消息构成

消息由以下几部分组成：

消息摘要：该条消息内容的简单摘要。

紧急程度：该条消息的紧急程度，分为：低、中、高。

接收组织：该条消息是发送到哪个组织的，即消息接收方。

发送消息的应用：该条消息是订阅的哪个应用产生的，即消息发送方。

消息标签：该条消息的标签。

消息发生时间：该条消息的产生时间。

消息详情：消息的具体内容。

¶ 查看消息

可在具体消息列表页面查看消息

可点击网页右上角铃铛图标查看，点击后可以展示最近五条消息，点击消息会进入个人消息列表，查看消息详情

¶ 站内消息

“站内消息” 页面中包含 “产品消息”、“平台消息”两个分类。分别代表来自应用的告警消息以及来自平台的组织成员变化通知消息。可通过点击不同的消息分类进行查看。消息通知形式如下，当有新消息时，页面右上角会有气泡弹窗提醒：

消息列表

产品消息和平台消息的消息列表展示的内容有所差异，具体如下：

产品消息列表展示如下图：

分别展示了消息摘要、消息紧急程度、消息接收组织、消息标签、以及消息的产生时间等信息。

平台消息列表相较于产品消息列表而言，更加简洁，包含了：消息摘要、组织信息、以及消息产生时间。如下图：

消息详情

产品消息的消息详情通过点击消息列表中任意一条消息查看，点击消息列表后，侧弹展示。效果如下图：

产品消息的消息详情相较于消息列表而言，可以查看该条消息的详细内容描述。

平台消息的消息详情和消息列表无明显差异。

消息的筛选

产品消息页面可以按照：产生消息的应用、接收消息的组织、消息的阅读状态（已读、未读）以及关键字进行筛选查找。

平台消息页面可以按照：消息的阅读状态（已读、未读）以及关键字进行筛选查找。

消息通知

消息通知界面用于对站内消息进行站外转发的规则配置，百川系统会根据用户的配置进行消息与规则的匹配以及消息的站外转发。页面效果如下：

其中系统会默认为每个用户分别创建两条规则：站内消息弹窗通知、微信公众号推送，这两条规则可关闭，可设置过滤条件，但不可删除。用户也可自定义规则，如上图中的“全渠道推送”，用户自定义规则可修改、删除。

注意：消息通知设置的过滤条件只会影响到消息接收的提醒效果（包括站内提醒和站外提醒），但是不会影响到消息的接收，发送给用户、用户所在组织的消息，均可通过百川平台的消息列表页面查看到。

¶ 新建通知策略

点击页面右上角的“新建通知策略”按钮，可进行通知策略的新建。效果如下：

规则描述：必填项，用户自定义一个新的规则描述，区分不同的规则，方便后期快速查找。

组织：非必填项，下拉选择用户所在的组织，该配置项通过消息的接收组织进行消息的过滤，若选择了一个或多个组织，则只会接收到发送到该一个或多个组织的消息提醒，没有选择的不会接收，若没有选择任何组织，则代表接收用户所在的所有组织消息提醒。

产品应用：非必填项，下拉选择不同产品应用，该配置项通过产生消息的应用进行消息的过滤，若选择了一个或多个应用，则只会接收到该一个或多个应用所产生的消息提醒，没有选择的不会接收，若没有选择任何应用，则代表接收所有应用产生的消息提醒。

接收渠道：可以选择（邮箱、钉钉、企业微信、飞书）四种渠道接收消息的提醒。

邮箱

邮箱接收渠道配置如下：

勾选邮箱选择框后，弹出邮箱地址输入框，最多支持十个地址

钉钉

钉钉接收渠道配置如下：

需要输入webhook地址，如果配置了密钥，需要将密钥一同填好，最多支持五条

企业微信

飞书

企业微信以及飞书同钉钉，不再展示。

消息通知设置

消息通知设置界面如下图所示，与新建通知策略基本相同，适用于各种消息通知设置，其中由于站内消息的规则与微信公众号推送的规则是系统创建，其规则描述不可修改。

消息通知可按照“组织”、“产品应用”两个纬度进行过滤配置。例如：组织选择了组织A后，则只会接收到发送给组织A的消息提醒（站内提醒、站外提醒），产品应用过滤规则同组织过滤规则，即选择了应用A后，则只会接收到应用A发送的消息提醒（站内提醒、站外提醒）。

注意：组织、产品应用的过滤，只在当前的通知策略内生效，不影响其他通知策略的提醒接收

不同规则配置说明

站内消息弹窗通知规则

站内消息规则配置，用于控制站内消息是否弹窗以及按照指定消息进行过滤。该规则默认开启、无消息过滤。若关闭该过滤规则，站内消息的气泡弹窗提醒将会消失。

微信公众号推送规则

微信公众号推送规则配置，用于控制百川公众号推送消息提醒到用户的个人微信。开启规则配置需要用户关注百川公众号，若关闭则用户微信不会接收到来自百川平台的消息推送通知。

自定义通知规则

用户自定义规则配置中，可以配置除站内、微信公众号两种方式以外的其他各种方式。过滤规则同上，影响范围都是当前策略中的接收渠道，不同的策略互不影响。

发信测试

策略列表中的发信测试

在策略列表中，每条策略都有其相对应的发信测试按钮，点击后，会按照该策略的接收地址，进行模拟消息发送，发送测试后会显示发送结果。可注意查收配置地址是否收到，若接收消息地址没有接到，建议先确认地址是否正确，确认无误可联系百川平台管理员协助排查。

注：所有站外转发的发信测试每分钟只能测试一次，站内转发的发信测试无限制。

策略设置中的发信测试

除了策略列表中可以发信测试，在新建通知策略，或设置通知策略时，也可以进行发信测试，在勾选接收渠道后，弹出的地址栏下方会有发信测试按钮，点击按钮即可对当前所输入的地址进行测试，方便确认地址是否正确有效。系统自带的策略规则只能在策略列表中进行测试，不可以在设置中测试

¶ 空间管理

空间是百川云中所有资源的载体，云产品、主机、文件、日志等数据资源依附于组织而存在，这些资源在空间范围内处于共享状态，空间内有相关权限的成员均可以访问这些资源。

访问工作台 〉〉 管理，可对当前空间进行查看信息、邀请成员、管理角色、管理消息等操作。操作界面如下图所示：

¶ 信息

信息界面可查看当前空间的基本信息，包含空间名，空间id等，也可对名称、描述进行修改。同时该界面提供了解散空间、退出空间操作。

解散空间：

若用户具有当前空间的管理员权限，则可以对空间进行解散操作，解散空间后无法找回组织，且空间已开通的资源，消息等，用户无法再查看，需谨慎操作

退出空间：

用户可主动退出当前空间，若用户是当前空间唯一管理员，那么需要先指定一个其他用户成为空间管理员后，方可退出空间，退出空间后，空间开通的资源、消息等用户不可再使用

¶ 用户

用户是空间的组成部分，用户通过绑定不同的角色，来获取不同的权限，从而进行不同的操作。

用户界面可以查看目前空间内成员，其中包含用户名称、用户角色、最近登录时间等信息。空间管理员可以在这里对空间内每个成员进行管理操作。用户角色决定了在空间内能进行的操作内容。

修改用户角色

点击用户的角色列表，进入修改用户角色页面，右侧是空间内的所有角色（可以在角色页面进行维护），左侧是已经选择的角色，点击确认修改后，用户将会具有右侧展示的角色，点击取消，取消本次操作，退回用户列表页面。

删除用户

点击用户后面所对应的删除按钮，删除当前用户，删除用户后，该用户将无法进入该空间。

¶ 角色

角色表示具有某些权限的一类群体，用户可以通过绑定角色，从而获得这个角色所具有的权限。

角色页面展示了当前空间所有的角色信息，创建空间时，系统会自动给空间生成管理员与访客两个角色，空间的创建者默认为管理员角色，拥有空间的最高权限，点击右上角的创建角色按钮，可以给当前空间创建新的角色

创建角色

手动创建

创建角色页面，可以为空间新增角色，需要填写角色名称以及该角色所具有的权限（权限的定义在权限页面可以查看），一次支持填写多个角色，点击添加角色可以继续添加，添加完成后，点击页面的右下角确认创建按钮创建角色，点击取消则取消本次操作。创建完成后，可以在角色列表处查看到新增的角色，同时，可以给空间内的用户赋予新角色。

自动创建

在空间开通了应用后，系统也会自动为该空间创建对应该应用的权限，以及拥有该权限的角色，如下：

同时，会给空间的管理员赋予新开通的应用管理员角色。

删除角色

系统默认自带的管理员、访客这两个角色不允许删除，用户自建角色可以删除，删除后，已经拥有该角色的用户会自动失去该角色，角色列表也不再能查看到该角色。

¶ 权限

权限页面展示了当前空间的所有权限列表。权限表示了可以在空间内操作的范围和程度，角色可以通过绑定各种权限，获得各种范围的操作许可。

在开通空间时，系统会默认生成管理空间信息、访客两种权限，类型为平台类型--即在百川平台侧的权限。权限不支持手动维护（新增、修改、删除），在空间开通应用后，会为当前组空间自动生成对应的权限，可通过类型区分不同应用的权限。如下图所示：

在生成权限后，空间管理员可以通过角色界面自定义一个包含指定平台、应用权限的角色。并将该权限赋予到用户上。