All Products
Search
Document Center

Simple Log Service:Global parameters

Last Updated:Oct 26, 2023

You do not need to configure global parameters each time you run a command in Simple Log Service CLI. By default, Simple Log Service CLI uses global parameters to process requests. This topic describes the global parameters of Simple Log Service CLI.

Parameter

Type

Required

Example

Description

--access-id

String

No

LTAI4G243ui******pLMZ

The AccessKey ID. Set the value to the AccessKey ID of your account. For more information about how to obtain an AccessKey ID, see AccessKey pair.

--access-key

String

No

XjAsPzvbK******QFRqax

The AccessKey secret. Set the value to the AccessKey secret of your account. For more information about how to obtain an AccessKey secret, see AccessKey pair.

--sts-token

String

No

None

The Security Token Service (STS) token. For more information, see Use STS to enable cross-account access to Log Service resources.

--region-endpoint

String

No

cn-hangzhou.log.aliyuncs.com

The Simple Log Service endpoint. For more information, see Endpoints.

--client-name

String

No

test

The name of the client that sends requests. Set the value to the account that is used to send requests.

--format-output

String

No

json

The format of output. Valid values:

  • json: The output is in the JSON format.

  • no_escape: The original characters are returned, and non-English characters are not escaped in the output.

For example, if you specify --format-output=json,no_escape, the original characters are returned, and non-English characters are not escaped in the output. The output is in the JSON format.

--jmes-filter

String

No

--jmes-filter="join('\n', map(&to_string(@), @))"

The JMES expression that is used to filter log data in output. For more information, see JMES syntax.

--decode-output

String

No

utf8

The decoding method that is used to parse log data. This parameter is available only if the log data is in the binary format. Valid values:

  • utf8: UTF-8 decoding is used to parse log data. This is the default value.

  • lartin1: Latin1 decoding is used to parse log data.

  • gbk: GBK decoding is used to parse log data.

--profile

String

No

akProfile

The credentials that are used to verify accounts. The credentials are included in the .aliyun/config.json configuration file of Alibaba Cloud CLI.

For more information about how to configure global parameters, see Configure Log Service CLI.