Simple Log Service:Configure SLS CLI

Credential sources and priority

SLS CLI reuses Alibaba Cloud CLI credentials when available—no additional account setup is needed. Configure Alibaba Cloud CLI.

Credential resolution priority (highest to lowest):

Configure the default account

SLS CLI uses the main account by default. Configure an AccessKey pair and endpoint for the main account and grant it permissions to manage projects.

1. Log on to the SLS CLI server.

2. Configure the default account credentials.

   Run the following command:

   aliyunlog configure "AccessKey ID" "AccessKey Secret" Endpoint

   • Replace AccessKey ID and AccessKey Secret with the credentials of an account with SLS permissions. For more information, see AccessKey pair and Create a RAM user and grant permissions.

   • Replace Endpoint with a project endpoint. Use a public endpoint. For more information, see Endpoint.

3. Verify the configuration.

   Open the .aliyunlogcli configuration file. If it contains output similar to the following, the default account is configured.

   [main]
   access-id = LTAI******pLMZ
   access-key = XjAsP******eRqax
   region-endpoint = cn-hangzhou.log.aliyuncs.com
   sts-token =

   Note

   The .aliyunlogcli file path by operating system:

   • Linux: ~/.aliyunlogcli

   • Windows: C:\Users\UserName\.aliyunlogcli

   If configuration fails, fix the error based on the returned error code.

Configure multiple accounts

To manage log data across accounts, configure credentials and endpoints for each account.

1. Log on to the SLS CLI server.

2. Configure credentials for additional accounts.

   Run the following command:

   aliyunlog configure "AccessKey ID" "AccessKey Secret" Endpoint Name

   • Replace AccessKey ID and AccessKey Secret with the credentials of an account with SLS permissions. For more information, see AccessKey pair and Create a RAM user and grant permissions.

   • Replace Endpoint with a project endpoint. Use a public endpoint. For more information, see Endpoint.

   • Replace Name with a custom account name.

3. Verify the configuration.

   Open the ~/.aliyunlogcli configuration file. If it contains output similar to the following, the accounts are configured.

   [main]
   access-id = LTAI******pLMZ
   access-key = XjAsP******eRqax
   region-endpoint = cn-hangzhou.log.aliyuncs.com
   sts-token =
   
   [test]
   access-id = As******sPzvb
   access-key = FtagJeR******bQqax
   region-endpoint = cn-shanghai.log.aliyuncs.com
   sts-token =

   Note

   The .aliyunlogcli file path by operating system:

   • Linux: ~/.aliyunlogcli

   • Windows: C:\Users\UserName\.aliyunlogcli

   If configuration fails, fix the error based on the returned error code.

   Use --client-name=testName to run a command with a specific account. For example, aliyunlog log create_project ..... --client-name=test runs the command as the test account.

Format output

SLS CLI supports JSON formatting and character escaping for output.

• Format JSON output

  By default, SLS CLI outputs JSON in a single line. Format the output using one of these methods:

  • Format the output of a specific command

    Example: aliyunlog log get_log .... --format-output=json formats the JSON output of the get_log command.

  • Format the output of all commands

    Run aliyunlog configure --format-output=json to format all command output globally.

• Escape characters

  By default, non-English characters in output are escaped. To return original characters, set --format-output to no_escape.

  Run aliyunlog configure --format-output=no_escape to disable escaping globally.

Escape special characters

Queries containing dollar signs ($), grave accents (`), backslashes (\), or exclamation points (!) may fail or return incorrect results.