Call the PutUserDefinedLogFieldsConfig operation to customize log fields - Object Storage Service

Configura campos personalizados en el elemento user_defined_log_fields de los registros en tiempo real del bucket para capturar encabezados de solicitud y parámetros de consulta específicos con fines de análisis.

Notas de uso

Para llamar a la operación PutUserDefinedLogFieldsConfig, debe contar con el permiso oss:PutUserDefinedLogFieldsConfig. Para obtener más información, consulte Grant a custom policy.
Los datos registrados se almacenan en formato JSON codificado en Base64 dentro del campo user_defined_log_fields. El JSON contiene tres claves: "truncated" (indica si los datos se truncaron), "headers" (encabezados de solicitud) y "querys" (parámetros de consulta).
Una configuración de registro admite un máximo de seis elementos en total entre encabezados de solicitud y parámetros de consulta personalizados.
La longitud combinada de clave y valor de todos los campos de encabezado de solicitud y parámetro de consulta personalizados en una configuración de registro no puede superar los 1,024 bytes. Los caracteres que excedan este límite se truncan.
Las claves de encabezado de solicitud permiten guiones (-), pero no guiones bajos (_). Las claves de parámetro de consulta sí permiten guiones bajos (_).
Las claves de encabezado de solicitud deben contener únicamente caracteres ASCII imprimibles (33–126), excluyendo guiones bajos (_) y dos puntos (:).

Sintaxis de la solicitud

PUT /?userDefinedLogFieldsConfig HTTP/1.1
Date: GMT Date
Content-Length: ContentLength
Content-Type: application/xml
Host: BucketName.oss.aliyuncs.com
Authorization: SignatureValue
<?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>

Encabezados de solicitud

Una solicitud PutUserDefinedLogFieldsConfig utiliza únicamente encabezados de solicitud comunes. Para obtener más información, consulte Common request headers.

Elementos de la solicitud

Elemento	Tipo	Obligatorio	Ejemplo	Descripción
UserDefinedLogFieldsConfiguration	Contenedor	Sí	N/A	Contenedor de la configuración de registro definida por el usuario. Elementos secundarios: HeaderSet y ParamSet Elementos primarios: ninguno
HeaderSet	Contenedor	No	N/A	Contenedor de los encabezados de solicitud personalizados. Elementos secundarios: header Elementos primarios: UserDefinedLogFieldsConfiguration
header	Cadena	No	header1	Encabezado de solicitud personalizado. Elementos secundarios: ninguno Elementos primarios: HeaderSet
ParamSet	Contenedor	No	N/A	Contenedor de los parámetros de consulta personalizados. Elementos secundarios: parameter Elementos primarios: UserDefinedLogFieldsConfiguration
parameter	Cadena	No	param1	Parámetro de consulta personalizado. Elementos secundarios: ninguno Elementos primarios: ParamSet

Encabezados de respuesta

La respuesta a una solicitud PutUserDefinedLogFieldsConfig utiliza únicamente encabezados de respuesta comunes. Para obtener más información, consulte Common response headers.

Ejemplos

Solicitud de ejemplo

PUT /?userDefinedLogFieldsConfig HTTP/1.1
Date: GMT Date
Content-Length: ContentLength
Content-Type: application/xml
Host: BucketName.oss.aliyuncs.com
Authorization: SignatureValue

<?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>

Respuesta de ejemplo

HTTP/1.1 200 OK
x-oss-request-id: 534B371674125A4D8906008B
Date: Date
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS

SDK de OSS

Puede utilizar los SDK de OSS para los siguientes lenguajes de programación con el fin de llamar a la operación PutUserDefinedLogFieldsConfig: