日志服务
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 日志服务 > 开发者指南 > 通过 iframe 内嵌 CLS（旧方案）

通过 iframe 内嵌 CLS（旧方案）

最近更新时间：2023-11-01 18:38:22

我的收藏

本页目录：

适用场景

日志服务提供 日志服务控制台 内嵌到其他系统的能力，满足免腾讯云账号登录控制台检索分析日志的诉求。通过内嵌日志服务云控制台页面，可以给用户带来以下方便：
在外部系统服务中（例如：公司内部运维或运营系统）快速集成日志服务的查询分析能力。
无需管理众多腾讯云子账号，方便将日志数据分享给他人进行查看。
说明：
CLS 已推出 DataSight 控制台，可一键启用。满足免腾讯云账号使用日志服务的诉求。推荐 通过 DataSight 使用日志服务。

使用演示代码实现免登录

注意
设置中可能存在以下风险，请参见安全意见进行操作：
临时密钥有效期请勿设置过长，建议设置在 5 分钟以内，可通过 AssumeRole 参数 DurationSeconds 指定。
包含参数的完整登录地址（https://cloud.tencent.cn/login/roleAccessCallback?algorithm...）请勿暴露在公网。
用户侧用于生成登录地址的系统需设置鉴权，例如内网身份校验，请勿设置成公开权限访问。
使用演示代码实现免登录的操作步骤如下：
1. 打开 访问管理 CAM 页面，创建 CAM 角色，选择角色载体为腾讯云账号，并勾选允许当前角色访问控制台，并为 CAM 角色配置相应的访问权限，例如：只读策略权限 QcloudCLSReadOnlyAccess ，并命名为 CLSReadOnly 。复制策略的 RoleArn 信息。
输入角色载体信息：
?
?
?
配置角色策略：
?
?
?
2. 打开 访问管理策略 页面，新建自定义策略，选择按策略生成器创建。进入页面后选择 JSON 标签，在策略内容中填写以下内容，注意将 ${YOUR_UIN} 替换为账号的 Uin（Resource 内容为创建的角色的 RoleArn ，如果策略名不一致，请注意修改）。单击下一步，并设置访问策略名为 PlayClsPolicy 。
{
 "version": "2.0",
 "statement": [
     {
         "effect": "allow",
         "action": [
             "sts:AssumeRole"
         ],
         "resource": [
             "qcs::cam::uin/${YOUR_UIN}:roleName/CLSReadOnly"
         ]
     }
 ]
}
3. 打开 新建用户 页面, 选择自定义创建。类型设置为可访问资源并接收消息，用户名可设置为 PlayClsUser ，访问方式为编程访问，用户权限设置为上步骤新建的策略 PlayClsPolicy 。提交新建用户操作后，复制保留生成的密钥 SecretId 和 SecretKey 。
4. 克隆免密登录控制台演示项目代码 cls-iframe-demo 。参见项目 ReadMe 内容，在根目录创建 .env 文件，填写 RoleArn, SecretId, SecretKey 信息，即完成了必要参数值的填写。
注意：
代码泄露可能会导致 SecretId 与 SecretKey 泄露，从而影响账号安全。为了保证账号安全，可参见 云 API 密钥安全方案推荐，安全使用密钥。同时根据权限最小化原则，使用具备最小化权限的子账户密钥。
参见免密登录控制台演示程序的 ReadMe 文档，运行项目后，即可查看免密登录控制台效果。
注意：
该示例中不包含鉴权外部系统鉴权逻辑，部署后所有访问者（即使未登录腾讯云）均可以在示例中配置的角色权限查看账户中的数据。为保障数据隐私及安全，请自行添加外部系统鉴权逻辑或限制其仅在内网中可访问，以确保有权限的用户才能够查看该页面。
5. 拼接日志服务免登录目标地址 s_url（可选，获取后填写在免登录项目的配置文件中，访问免登录服务后将自动跳转到此地址）。
检索分析页面
日志服务检索分析页面地址：
https://console.cloud.tencent.cn/cls/search?region=<region>&topic_id=<topic_id>
日志服务检索分析页面 URL 参数说明：
参数名称
必填
类型
描述
region
是
String
地域简称，例如：ap-shanghai 表示上海地域，其它可用地域简称参见 可用地域
topic_id
否
String
日志主题 ID
logset_name
否
String
日志集名称
topic_name
否
String
日志主题名称
multiple
否
String
指定为 true 时表示使用多主题检索功能；未指定时表示检索单个主题
topicType
否
String
指定为 metric 时表示查询指标主题；未指定时表示查询日志主题
time
否
String
要检索日志的起始时间至结束时间，格式样例： 2021-07-15T10:00:00.000,2021-07-15T12:30:00.000
queryBase64
否
String
检索分析语句，采用 base64Url 编码。检索分析语法规则参见 语法规则?
hideWidget
否
Boolean
隐藏右下角客服/文档按钮：默认不隐藏，true 表示隐藏
hideTopNav
否
Boolean
隐藏腾讯云控制台顶部菜单：默认不隐藏，true 表示隐藏
hideLeftNav
否
Boolean
隐藏腾讯云控制台左侧菜单：默认不隐藏，true 表示隐藏
hideTopicSelect
否
Boolean
隐藏日志主题选择列表：默认不隐藏，true 表示隐藏
collapseTopicSelect
否
Boolean
折叠主题选择列表：默认不折叠，true 表示折叠
hideTopTips
否
Boolean
隐藏顶部产品公告提示：默认不隐藏，true 表示隐藏
hideConfigMenu
否
Boolean
隐藏日志主题配置管理菜单：默认不隐藏，true 表示隐藏
hideDashboardMenu
否
Boolean
隐藏日志主题配置管理菜单中的仪表盘菜单：默认不隐藏，true 表示隐藏
hideAlertMenu
否
Boolean
隐藏日志主题配置管理菜单中的告警菜单：默认不隐藏，true 表示隐藏
hideCollectionMenu
否
Boolean
隐藏日志主题配置管理菜单中的采集配置菜单：默认不隐藏，true 表示隐藏
hideIndexMenu
否
Boolean
隐藏日志主题配置管理菜单中的索引配置菜单：默认不隐藏，true 表示隐藏
hideMoreMenu
否
Boolean
隐藏日志主题配置管理菜单中的更多菜单：默认不隐藏，true 表示隐藏
hideDashboard
否
Boolean
隐藏添加到仪表盘按钮：默认不隐藏，true 表示隐藏
hideAlert
否
Boolean
隐藏添加到告警按钮：默认不隐藏，true 表示隐藏
hideLogDownload
否
Boolean
隐藏原始日志下载按钮：默认不隐藏，true 表示隐藏
hideScheduleSql
否
Boolean
隐藏存为定时 SQL 分析按钮：默认不隐藏，true 表示隐藏
hideFavorite
否
Boolean
隐藏收藏夹按钮：默认不隐藏，true 表示隐藏
hideHistory
否
Boolean
隐藏历史记录按钮：默认不隐藏，true 表示隐藏
注意：
可通过两种方式在 URL 参数中指定需要检索的日志主题：
topic_id：根据日志主题 ID 指定日志主题。
logset_name+topic_name：根据日志集名称及日志主题名称指定日志主题，需要注意的是当日志集或日志主题名称发生变化时，采用该方式的 URL 会失效。
如 topic_id、logset_name 和 topic_name 参数同时存在，将以 topic_id 为准。
使用多主题检索功能时（multiple=true），可同时最多指定20个主题：
使用 topic_id：用英文逗号连接多个主题 ID。
使用 logset_name+topic_name：用英文逗号连接多个主题名称及日志集名称，主题名称需与所属日志集名称一一对应，例如topic_name=WAF 访问日志日志主题,CCN 流日志日志主题&logset_name=Demo 日志集,Demo 日志集。
隐藏参数与页面模块对应关系：
?
?
?
仪表盘页面
日志服务检索分析页面地址:
https://console.cloud.tencent.cn/cls/dashboard/d?id=<dashboard_id>
日志服务检索分析页面 URL 参数说明：
参数名称
必填
类型
描述
dashboard_id
是
String
仪表盘 ID
hideWidget
否
Boolean
隐藏右下角客服/文档按钮：默认不隐藏，true 表示隐藏
hideTopNav
否
Boolean
隐藏腾讯云控制台顶部菜单：默认不隐藏，true 表示隐藏
hideLeftNav
否
Boolean
隐藏腾讯云控制台左侧菜单：默认不隐藏，true 表示隐藏
hideHeader
否
Boolean
隐藏顶部 Header，包括 title 区域与返回按钮：默认不隐藏，true 表示隐藏
hideChartModifyOperation
否
Boolean
隐藏图表编辑操作入口 （包含新建图表、复制图表、编辑图表、删除图表、保存按钮）
hideChartGridDrag
否
Boolean
关闭图表拖拽移动能力：默认不关闭，true 表示关闭
hideChartGridResize
否
Boolean
关闭图表修改尺寸能力：默认不关闭，true 表示关闭
hideTimeSelector
否
Boolean
隐藏时间选择器：默认不隐藏，true 表示隐藏
hideRefreshSelector
否
Boolean
隐藏自动刷新按钮：默认不隐藏，true 表示隐藏
hideChartFullScreenOperation
否
Boolean
隐藏图表全屏显示操作按钮：默认不隐藏，true 表示隐藏
hideChartExportOperation
否
Boolean
隐藏图表导出数据操作按钮：默认不隐藏，true 表示隐藏
hideChartAddToAlarmOperation
否
Boolean
隐藏图表添加到监控告警操作按钮：默认不隐藏，true 表示隐藏
hideQueryPreview
否
Boolean
隐藏图表预览检索分析语句操作按钮：默认不隐藏，true 表示隐藏
hidePreviewInSearch
否
Boolean
隐藏在检索分析查看操作按钮：默认不隐藏，true 表示隐藏
hideFullScreen
否
Boolean
隐藏仪表盘全屏查看操作按钮：默认不隐藏，true 表示隐藏
隐藏参数与页面模块对应关系：
?

自行开发实现免登录

操作步骤

1. 参见 使用演示代码实现免登录 中的内容，在腾讯云账号中配置相应的 CLS 只读角色、 扮演角色的自定义策略、绑定自定义策略的子账号。配置完成后保存对应的 RoleArn, SecretId, SecretKey 信息。
2. 参见 使用演示代码实现免登录 中的内容，根据自身诉求，获取日志服务免登录目标地址 s_url。
3. 在每次需要打开免登录访问页面时，重复以下步骤内容。
4. 使用获取到的密钥，调用 STS AssumeRole 接口，申请扮演角色的临时密钥。
5. 基于获取到的临时密钥，生成登录签名信息。
5.1 签名参数排序
对要求签名的参数按照字母表或数字表递增顺序的排序，先考虑第一个字母，在相同的情况下考虑第二个字母，以此类推。您可以借助编程语言中的相 关排序函数来实现这一功能，例如：PHP中 的 ksort 函数。其中签名参数包含以下内容：
参数名称
必选
类型
描述
action
是
String
操作动作，固定为 roleLogin
timestamp
是
Int
当前时间戳
nonce
是
Int
随机整数，取值10000-100000000
secretId
是
String
STS 返回的临时 AK
5.2 拼接参数
将上一步排序好的请求参数，按参数名称=参数值拼接，例如：
action=roleLogin&nonce=67439&secretId=AKI***PLE&timestamp=1484793352
5.3 拼接签名串
按请求方法 + 请求主机 +请求路径 + ? + 请求字符串的规则拼接签名串。
参数
必选
描述
请求主机和路径
是
固定为 cloud.tencent.cn/login/roleAccessCallback
请求方法
是
支持 GET 或 POST
签名串示例：
GETcloud.tencent.cn/login/roleAccessCallback?action=roleLogin&nonce=67439&secretId=AKI***PLE&timestamp=1484793352
5.4 生成签名串
使用 HMAC-SHA1 算法对字符串签名，目前支持 HMAC-SHA1 和 HMAC-SHA256。具体代码如下，以 PHP 语言为例：
$secretKey = 'Gu5***1qA';
$srcStr    = 'GETcloud.tencent.cn/login/roleAccessCallback?action=roleLogin&nonce=67439&secretId=&timestamp=1484793352';
$signStr   = base64_encode(hash_hmac('sha1', $srcStr, $secretKey, true));
echo $signStr;

PHP 版本示例代码

$secretId  = "AKI***";            //STS 返回的临时 AK
$secretKey = "Gu5***PLE";         //STS 返回的临时 Secret
$token     = "ADE***fds";         //STS 返回的安全 TOKEN
$param["nonce"]     = 11886;      //rand(10000,100000000);
$param["timestamp"] = 1465185768; //time();
$param["secretId"]  = $secretId;
$param["action"]    = "roleLogin";
ksort($param);
$signStr = "GETcloud.tencent.cn/login/roleAccessCallback?";
foreach ( $param as $key => $value ) {
    $signStr = $signStr . $key . "=" . $value . "&";
}
$signStr   = substr($signStr, 0, -1);
$signature = base64_encode(hash_hmac("sha1", $signStr, $secretKey, true));
echo $signature.PHP_EOL;
1. 拼接完整登录信息以及目的页面地址进行登录。参数值需要 urlencode 编码。
https://cloud.tencent.cn/login/roleAccessCallback?
algorithm=<签名时加密算法，目前只支持 sha1 和 sha256 ，不填默认 sha1>
&secretId=<签名时 secretId>
&token=<临时密钥 token>
&nonce=<签名时 nonce>
&timestamp=<签名时 timestamp>
&signature=<签名串>
&s_url=<登录后目的 URL>
2. 使用生成的最终链接，访问腾讯云日志服务控制台页面。例如检索分析页面的内嵌访问链接如下：
https://cloud.tencent.cn/login/roleAccessCallback?nonce=52055817&s_url=https%3A%2F%2Fconsole.cloud.tencent.cn%2Fcls%2Fsearch%3Fregion%3Dap-guangzhou%26start_time%3D2020-05-26%25252014%25253A01%25253A18%26end_time%3D2020-05-26%25252014%25253A16%25253A18&secretId=AKID-vHJ7WPHcy_RVIOm-QTIktXOf9S9z_k_JackOp3dyQPJwmDrNLQJuiNuw9******&signature=eXeWaDn6iJlcPp1sqqGd6m9%2FQk****&timestamp=1592455018&token=5e4vuBHL7fBQPi1V9fvSINw4Vu7PSr9Ic3de78b86109c171eb4e3ea27c137c1fIWKU8JC-LO01L87sIYlfTSaHHXeHcqim7Jg9hBuN2nbdfgeBUPXhmpyAk4G6e9bHFZ-7yNRig7Y33CQHxh6jOesP4VfhRzQprWGRtC5No1ty******-aoj_WJhA55oyvqaqxw2jtTdh8nx9OjJr3tlbIa9oJe7aZYoPbdpFqrF6ZjlCPPap2yQB_SkUsWwDl_9BrK2Km3U2IocdvQ7QxrW0ts1aiBi7xtTSJRcfkBYPYEV_YoJrtkhYW3E4L47imA1bfVAjM9F5uKWzVzsDGDT0aCUU9mqdb4vjJrY8tm-wJKKEe8eiyY9EbkH3VWnFV2YocYNDJqFyjKOWR******

技术实现原理

免密登录控制台方案 技术上基于 安全凭证服务 。 登录原理流程图：
?
img
?
?
中国站


http://www.vxiaotou.com