Embedding CLS Console

Last updated: 2020-10-27 12:15:16


    CLS allows you to embed the CLS Console into an external system so you can conduct log search and analysis without logging in to Tencent Cloud console. This feature offers benefits as follows:

    • Quickly integrate CLS search and analysis capabilities into an external service system (e.g., for business maintenance or operation).
    • Easily share your log data with others without managing additional Tencent Cloud sub-accounts.

    See the figure below for an overview of this feature:


    1. Log in to the CAM Console to create a CAM Role with console login permissions. Set the role entity to root account, e.g. CompanyOpsRole. Grant the CAM role appropriate access permissions using policies, e.g. QcloudCLSReadOnlyAccess for read-only access. You can create a CAM role in 2 ways: using the console or using APIs.

      • Creating a CAM role using the console:

        1. Log in to the CAM Console.
        2. Click Roles in the left sidebar to enter the role list page.
        3. Select Create Role > Tencent Cloud Account to create a custom role.
        4. Select Current root account, check Allow current role to log in to the console, and click Next.


        If the option *Allow current role to log in to the console is not available, submit a ticket to be allowed for this feature.

        1. Set access policies for the role, e.g., the read-only policy QcloudCLSReadOnlyAccess, and click Next.
        1. Enter the role name and click Done.

    • Creating a CAM role using APIs:
      For detailed directions, see CreateRole. Note that you need to enter “1” as the value of ConsoleLogin to allow the role to log in to the console.
      Sample request:
      1. Obtain the access key of current user. For more information, see Root Account Access Key.


    1. Log in to the web server outside Tencent Cloud.

    2. The external web server assigns you the pre-created role created in Prerequisite 1 based on your identity, e.g. CompanyOpsRole.

    3. Use the role to access Tencent Cloud STS within the external web server, and call the AssumeRole API with the access key obtained in Prerequisite 2 to request the temporary key for the CAM role CompanyOpsRole.

    4. You will get the temporary key when the call succeeds.

    5. Generate a login signature using the temporary key with the steps as shown below:

      1. Sorting parameters
        Sort parameters to be signed listed below in ascending alphabetical or numerical order. That is, sort the parameters by their first letters, then by their second letters if their first letters are the same, and so on. You can do this with the aid of sorting functions in programming languages, such as the ksort function in PHP.

        Parameter Name Required Type Description
        action Yes String Action; fixed as `roleLogin`
        timestamp Yes Int Current timestamp
        nonce Yes Int Random integer. Value range: 10000-100000000
        secretId Yes String Temporary AK returned by STS
      2. Concatenating parameters
        Concatenate the above sorted parameters into the form of "parameter name=parameter value". Example:

      3. Concatenating a signature string

    Concatenate a signature string in the format of “request method + request CVM + request path + ? + request string”.

    Parameter Required Description
    Request CVM and path Yes Fixed as cloud.tencent.com/login/roleAccessCallback
    Request method Yes GET or POST

    Sample signature string


    iv. Generating a signature string

    Currently, you can sign a string using HMAC-SHA1 or HMAC-SHA256. The sample code in PHP is as follows:

    $secretKey = 'Gu5***1qA';
    $srcStr    = 'GETcloud.tencent.com/login/roleAccessCallback?action=roleLogin&nonce=67439&secretId=&timestamp=1484793352';
    $signStr   = base64_encode(hash_hmac('sha1', $srcStr, $secretKey, true));
    echo $signStr;

    Sample code for PHP

    $secretId  = "AKI***";            //Temporary AK returned by STS
    $secretKey = "Gu5***PLE";         //Temporary SecretKey returned by STS
    $token     = "ADE***fds";         //Security Token returned by STS
    $param["nonce"]     = 11886;      //rand();
    $param["timestamp"] = 1465185768; //time();
    $param["secretId"]  = $secretId;
    $param["action"]    = "roleLogin";
    $signStr = "GETcloud.tencent.com/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. Combine your login information and destination page URL into a login URL.

      1. Get the CLS Console search analysis page URL.

    Parameters in the CLS Console search analysis page URL:

    Parameter Name Required Type Description
    region Yes String Region abbreviation, e.g. ap-shanghai for Shanghai region. For other available region abbreviations, see Available Regions
    logset_id Yes String Logset ID
    topic_id Yes String Log topic ID
    start_time No String Start time of logs to search, e.g. 2019-11-13 10:00:00
    end_time No String End time of logs to search, e.g. 2019-11-13 20:00:00
    query No String Keyword search syntax. Reserved URL characters (if any) in keywords must be URL encoded.
    hideWidget No Boolean Indicates whether to hide the Smart Customer Service icon. `true`: Yes; `false`: No
    hideTopNav No Boolean Indicates whether to hide the top navigation bar in Tencent Cloud console. `true`: Yes; `false`: No
    hideLeftNav No Boolean Indicates whether to hide the left sidebar in Tencent Cloud console. `true`: Yes; `false`: No
    hideHeader No Boolean Indicates whether to hide the top navigation bar in CLS page (title and region options). `true`: Yes; `false`: No
    hideTopTips No Boolean Indicates whether to hide the tips at the top of CLS page. `true`: Yes; `false`: No
    hideRegion No Boolean Indicates whether to hide region options at the top of CLS page. `true`: Yes; `false`: No
    hideLogsetSelect No Boolean Indicates whether to hide logset options in CLS page. `true`: Yes; `false`: No
    hideTopicSelect No Boolean Indicates whether to hide log topic options in CLS page. `true`: Yes; `false`: No

    ii. Combine your login information and destination page URL into a login URL. The parameter values must be URL-encoded.

    ?algorithm=<encryption algorithm for signing; currently only supports sha1 (used by default) and sha256
    &secretId=<secretId for signing>
    &token=<Token of the temporary key>
    &nonce=<nonce for signing>
    &timestamp=<timestamp for signing>
    &signature=<signature string>
    &s_url=<destination URL after login>
    1. Use the final URL to access the embedded Tencent Cloud CLS Console page. The sample below is a URL to the CLS search analysis page:

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback