put-user-defined-log-fields-config

更新时间:2025-01-15 06:26:17

put-user-defined-log-fields-config命令用于实时配置用户自定义日志字段。通过将自定义请求头或查询参数添加为日志字段,可便于后续对请求数据进行分析。

注意事项

阿里云账号默认拥有配置自定义日志字段所需的权限。如果您需要通过RAM用户或者STS的方式进行自定义,您必须拥有oss:PutUserDefinedLogFieldsConfig权限。具体操作,请参见RAM用户授权自定义的权限策略

命令格式

ossutil api put-user-defined-log-fields-config --bucket value --user-defined-log-fields-configuration value [flags]

参数

类型

说明

参数

类型

说明

--bucket

string

Bucket名称。

--user-defined-log-fields-configuration

string

存储指定日志配置的容器。

说明

put-user-defined-log-fields-config命令对应API接口PutUserDefinedLogFieldsConfig。关于API中的具体参数含义,请参见PutUserDefinedLogFieldsConfig

--user-defined-log-fields-configuration

--user-defined-log-fields-configuration配置选项既支持XML语法也支持JSON语法,当选项值包含file://前缀时,表示从文件中读取配置。

  • XML语法:

    <HeaderSet>
      <header>string</header>
      ...
    </HeaderSet>
    <ParamSet>
      <parameter>string</parameter>
      ...
    </ParamSet>
  • JSON语法:

    {
      "HeaderSet": {
        "header": ["string", ...]
      },
      "ParamSet": {
        "parameter": ["string", ...]
      }
    }
说明

关于支持的全局命令行选项,请参见支持的全局命令行选项

使用示例

通过添加自定义请求头或查询参数来实时定制user_defined_log_fields字段,以便后续分析对存储空间examplebucket的请求。

  • 使用XML配置文件,user-defined-log-fields-configuration.xml内容如下:

    <?xml version="1.0" encoding="UTF-8"?>
    <UserDefinedLogFieldsConfiguration>
      <HeaderSet>
         <header>header1</header>
         <header>header2</header>
         <header>header3</header>
      </HeaderSet>
      <ParamSet>
         <parameter>param1</parameter>
         <parameter>param2</parameter>
      </ParamSet>
    </UserDefinedLogFieldsConfiguration>

    命令示例如下:

    ossutil api put-user-defined-log-fields-config --bucket examplebucket --user-defined-log-fields-configuration file://user-defined-log-fields-configuration.xml
  • 使用JSON配置文件,user-defined-log-fields-configuration.json 内容如下:

    {
      "HeaderSet": {
        "header": [
          "header1",
          "header2",
          "header3"
        ]
      },
      "ParamSet": {
        "parameter": [
          "param1",
          "param2"
        ]
      }
    }

    命令示例如下:

    ossutil api put-user-defined-log-fields-config --bucket examplebucket --user-defined-log-fields-configuration file://user-defined-log-fields-configuration.json
  • 使用JSON配置参数,命令示例如下:

    ossutil api put-user-defined-log-fields-config --bucket examplebucket --user-defined-log-fields-configuration "{\"HeaderSet\":{\"header\":[\"header1\",\"header2\",\"header3\"]},\"ParamSet\":{\"parameter\":[\"param1\",\"param2\"]}}"
  • 本页导读 (1)
  • 注意事项
  • 命令格式
  • --user-defined-log-fields-configuration
  • 使用示例
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等