AI 助理
备案控制台
文档
有奖调研
输入文档关键字查找
首页 日志服务 开发参考 可视化开发 控制台内嵌及分享（新版）延长访问时间

控制台内嵌及分享（新版）延长访问时间

更新时间：
产品详情
相关技术圈
我的收藏

如果您需要将日志服务的查询分析结果、仪表盘等页面，分享给其他人或者嵌入到第三方系统，可以通过CreatTicket接口生成ticket，然后拼接成免密且免登录的链接进行分享。但通过CreatTicket接口生成的ticket只有短暂的有效期，如果需要刷新可免密且免登录链接的有效时间，可以使用RefreshToken接口。本文介绍详细的操作步骤。

工作原理

image

前提条件

已经已生成免密且免登录链接，操作步骤请参见控制台内嵌及分享（新版）。

操作步骤

步骤一：为RAM用户授权

如果使用阿里云主账号，可跳过这步，直接前往步骤二。

  1. 使用生成内嵌的RAM用户登录RAM控制台。

  2. 为RAM用户授予调用RefreshToken接口权限。具体操作步骤请参见为RAM用户授权和创建自定义权限策略。

    {
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "log:RefreshToken",
            "Resource": "acs:log:*:*:ticket/*"
        }
    ]
}

步骤二：内嵌链接增加参数

控制台内嵌及分享（新版）生成的链接拼接supportRefreshToken参数，该参数用于指示第三方是否支持刷新令牌（RefreshToken）。设置为supportRefreshToken=true，表示允许链接延长访问时间。

https://sls.console.aliyun.com/lognext/project/<Project名称>/dashboard/<仪表盘ID>?sls_ticket=eyJ***************.eyJ******************.KUT****************&supportRefreshToken=true&isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true

步骤三：客户端增加监听事件

客户端监听message事件，将最新的accessToken传给iframe。

window.addEventListener('message', async (e) => {
  if (e?.data?.type === 'refreshToken') {
    const accessToken = await callApi()
    document.querySelector('#myIframe').contentWindow.postMessage(
      {
        // 固定为applyAccessToken
        type: 'applyAccessToken',
        // 调用callApi返回的accessToken
        accessToken,
        // createTicket接口返回的ticket
        ticket: e.data.ticket,
      },
      '*'
    )
  }
})
重要

  • callApi()方法是自定义方法。作用是应用客户端调用应用服务端的API，服务端的API作用是调用开发门户的RefreshToken获取accesstoken。集成RefreshToken代码请参见代码示例。

  • 调用RefreshToken获取accessToken，服务地址只能是华东2（上海）或新加坡，但获取的accessToken可以在各个地域使用。

  • RefreshToken的两个入参：ticket是CreateTicket生成的票据。accessTokenExpirationTime表示调用接口生成的访问令牌过期时间（秒），默认86400秒（一天），最大86400秒（一天）。该票据最多延长过期时间为30天（RefreshToken每天在过期之前调用一次），30天后该票据过期。

代码示例

RefreshToken代码示例如下：

Java

  1. 添加Maven依赖。

    在Java项目的根目录下，打开pom.xml文件，添加以下代码：

        <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>sls20201230</artifactId>
      <version>5.2.1</version>
    </dependency>
    <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>tea-openapi</artifactId>
      <version>0.3.2</version>
    </dependency>
    <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>tea-console</artifactId>
      <version>0.0.1</version>
    </dependency>
    <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>tea-util</artifactId>
      <version>0.2.21</version>
    </dependency>

  2. 生成accessToken。

    // This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.sls20201230.Client;
import com.aliyun.tea.*;

public class Sample {

    /**
     * 使用AK&SK初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static Client createClient() throws Exception {
        // 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        // 建议使用更安全的 STS 方式。
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // Endpoint 请参考 https://api.aliyun.com/product/Sls
        config.endpoint = "cn-shanghai.log.aliyuncs.com";
        return new Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.sls20201230.Client client = Sample.createClient();
        com.aliyun.sls20201230.models.RefreshTokenRequest refreshTokenRequest = new com.aliyun.sls20201230.models.RefreshTokenRequest()
                .setTicket("eyJ***************.eyJ******************.KUT****************")
                .setAccessTokenExpirationTime(60L);
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        java.util.Map<String, String> headers = new java.util.HashMap<>();
        try {
            com.aliyun.sls20201230.models.RefreshTokenResponse resp = client.refreshTokenWithOptions(refreshTokenRequest, headers, runtime);
            com.aliyun.teaconsole.Client.log(com.aliyun.teautil.Common.toJSONString(resp));
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_sls20201230.client import Client as Sls20201230Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_sls20201230 import models as sls_20201230_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Sls20201230Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # Endpoint 请参考 https://api.aliyun.com/product/Sls
        config.endpoint = f'cn-shanghai.log.aliyuncs.com'
        return Sls20201230Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        refresh_token_request = sls_20201230_models.RefreshTokenRequest(
            ticket='eyJ***************.eyJ******************.KUT****************',
            access_token_expiration_time=60
        )
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.refresh_token_with_options(refresh_token_request, headers, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        refresh_token_request = sls_20201230_models.RefreshTokenRequest(
            ticket='eyJ***************.eyJ******************.KUT****************',
            access_token_expiration_time=60
        )
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.refresh_token_with_options_async(refresh_token_request, headers, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

上一篇：控制台内嵌及分享（新版）下一篇：控制台内嵌及分享
文档推荐