全部產品
Search
文件中心

Object Storage Service:put-user-defined-log-fields-config

更新時間:Jan 16, 2025

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\"]}}"