CreateTrail - ActionTrail - Centro de documentación de Alibaba Cloud

Crea una pista para entregar eventos a un destino con fines de almacenamiento y análisis a largo plazo, como un bucket de Object Storage Service (OSS), un Logstore de Simple Log Service (SLS) o un proyecto de MaxCompute.

Descripción de la operación

Nota

De forma predeterminada, una pista que se crea mediante esta API se encuentra en estado deshabilitado. Debe llamar a la operación StartLogging para habilitar la pista. Una vez habilitada la pista, ActionTrail comienza a entregar eventos al destino especificado.

Requisitos previos

Antes de crear una pista, debe tener configurado al menos uno de los siguientes recursos como destino:

OSS

Debe activar OSS y crear un bucket.
SLS

Debe activar SLS y crear un Logstore.

Nota
Cuando crea una pista con un destino SLS, ActionTrail crea automáticamente un Logstore denominado actiontrail_<trail_name> en el proyecto especificado. Para garantizar la integridad de los datos de auditoría, este Logstore solo acepta eventos entregados por ActionTrail.
MaxCompute

Debe activar MaxCompute.

Nota
Cuando crea una pista con un destino MaxCompute, ActionTrail crea automáticamente un proyecto denominado actiontrail_<account_ID>. Para garantizar la integridad de los datos de auditoría, este proyecto solo acepta eventos entregados por ActionTrail.

Notas de uso

Este ejemplo muestra cómo crear una pista de cuenta única denominada trail-test que entrega eventos a un bucket de OSS denominado audit-log.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

actiontrail:CreateTrail

create

*Trail

acs:actiontrail:{#regionId}:{#accountId}:trail/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Name	string	Sí	El nombre de la pista. Nota Longitud: de 6 a 36 caracteres. Caracteres: letras minúsculas, dígitos, guiones (-) y guiones bajos (_). Debe comenzar con una letra minúscula. Debe ser único dentro de una cuenta de Alibaba Cloud.	trail-test
OssBucketName	string	No	El nombre del bucket de OSS al que ActionTrail entrega eventos. Longitud: de 3 a 63 caracteres. Caracteres: letras minúsculas, dígitos y guiones (-). Debe comenzar con una letra minúscula o un dígito. Nota Debe especificar un destino para la pista proporcionando al menos uno de los siguientes parámetros: `OssBucketName`, `SlsProjectArn` o `MaxComputeProjectArn`.	audit-log
OssKeyPrefix	string	No	El prefijo para los nombres de los archivos de registro que ActionTrail entrega a su bucket de OSS. Longitud: de 6 a 32 caracteres. Caracteres: letras, dígitos, guiones (-), barras diagonales (/) y guiones bajos (_). Debe comenzar con una letra.	at-product-account-audit-B
OssWriteRoleArn	string	No	El nombre de recurso de Alibaba Cloud (ARN) del rol de RAM que ActionTrail asume para entregar eventos al bucket de OSS. Si no especifica este parámetro, ActionTrail crea un rol vinculado al servicio para entregar eventos. Para obtener más información, consulte Rol vinculado al servicio de ActionTrail. Si especifica un rol, debe ser un rol de RAM que usted haya creado. Este rol debe tener una política de confianza que permita al servicio ActionTrail (actiontrail.aliyuncs.com) asumirlo. La política de RAM del rol debe otorgar permisos de escritura en el bucket de OSS especificado. Para obtener más información sobre la entrega entre cuentas, consulte Entregar eventos desde varias cuentas de Alibaba Cloud a la misma cuenta.	acs:ram::15127787691****:role/aliyunserviceroleforactiontrail
SlsProjectArn	string	No	El ARN del proyecto de SLS al que ActionTrail entrega eventos. Nota Debe especificar un destino para la pista proporcionando al menos uno de los siguientes parámetros: `OssBucketName`, `SlsProjectArn` o `MaxComputeProjectArn`.	acs:log:cn-shanghai:151266687691****:project/test-project
SlsWriteRoleArn	string	No	El ARN del rol de RAM que ActionTrail asume para entregar eventos al proyecto de SLS. Si no se especifica este parámetro, ActionTrail crea un rol vinculado al servicio para entregar eventos. Para obtener más información, consulte Rol vinculado al servicio de ActionTrail. Si especifica un rol, debe ser un rol de RAM que usted haya creado. Este rol debe tener una política de confianza que permita al servicio ActionTrail (actiontrail.aliyuncs.com) asumirlo. La política de permisos del rol debe otorgar permisos de escritura en el proyecto de SLS especificado. Para obtener más información sobre la entrega entre cuentas, consulte Entregar eventos desde varias cuentas de Alibaba Cloud a la misma cuenta.	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
EventRW	string	No	Especifica el tipo de lectura/escritura de los eventos que entrega la pista. Valores válidos: Write: Eventos de escritura. Read: Eventos de lectura. All (predeterminado): Todos los eventos de lectura y escritura.	Write
TrailRegion	string	No	La región en la que se crea la pista. De forma predeterminada, una pista se crea en todas las regiones y este parámetro se establece en `All`. Para crear una pista en una región específica, proporcione el ID de la región. Para obtener más información sobre las regiones, llame a la operación DescribeRegions.	All
IsOrganizationTrail	boolean	No	Especifica si la pista es una pista multicuenta. Valores válidos: true false (predeterminado) Para crear una pista para una organización, establezca este parámetro en `true`. La pista recopilará eventos de todas las cuentas miembro de la organización.	false
MaxComputeProjectArn	string	No	El ARN del proyecto de MaxCompute al que ActionTrail entrega eventos. Nota Debe especificar un destino para la pista proporcionando al menos uno de los siguientes parámetros: `OssBucketName`, `SlsProjectArn` o `MaxComputeProjectArn`. Nota El nombre del proyecto en el ARN debe comenzar con `actiontrail_`.	acs:odps:cn-hangzhou:15127787691**:project/actiontrail_**
MaxComputeWriteRoleArn	string	No	El ARN del rol de RAM que ActionTrail asume para entregar eventos al proyecto de MaxCompute. Si no se especifica este parámetro, ActionTrail crea un rol vinculado al servicio para entregar eventos. Para obtener más información, consulte Rol vinculado al servicio de ActionTrail. Si especifica un rol, debe ser un rol de RAM que usted haya creado. Este rol debe tener una política de confianza que permita al servicio ActionTrail (`actiontrail.aliyuncs.com`) asumirlo. La política de permisos del rol debe otorgar permisos de escritura en el proyecto de MaxCompute especificado. Para obtener más información sobre la entrega entre cuentas, consulte Entregar eventos desde varias cuentas de Alibaba Cloud a la misma cuenta.	acs:ram::15127787691****:role/aliyunserviceroleforactiontrail

Para obtener más información, consulte Parámetros comunes.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
EventRW	string	El tipo de lectura/escritura de los eventos que entrega la pista.	Write
HomeRegion	string	La región principal de la pista.	cn-hangzhou
MaxComputeProjectArn	string	El ARN del proyecto de MaxCompute al que la pista entrega eventos.	acs:odps:cn-hangzhou:151266687691**:project/actiontrail_**
MaxComputeWriteRoleArn	string	El ARN del rol de RAM que ActionTrail asume para entregar eventos al proyecto de MaxCompute.	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
Name	string	El nombre de la pista.	trail-test
OssBucketName	string	El nombre del bucket de OSS de destino.	audit-log
OssKeyPrefix	string	El prefijo para los nombres de los archivos de registro en el bucket de OSS.	at-product-account-audit-B
OssWriteRoleArn	string	El ARN del rol de RAM que ActionTrail asume para entregar eventos al bucket de OSS.	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
RequestId	string	El ID de la solicitud.	442DDADF-DA58-4029-8E8B-82C73E9A7A70
SlsProjectArn	string	El ARN del proyecto de SLS al que la pista entrega eventos.	acs:log:cn-hangzhou:151266687691****:project/test-project
SlsWriteRoleArn	string	El ARN del rol de RAM que ActionTrail asume para entregar eventos al proyecto de SLS.	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
TrailRegion	string	La región en la que se crea la pista. Un valor de `All` indica que la pista procesa eventos de todas las regiones.	All

Ejemplos

Respuesta exitosa

JSON Formato

{
  "EventRW": "Write",
  "HomeRegion": "cn-hangzhou",
  "MaxComputeProjectArn": "acs:odps:cn-hangzhou:151266687691****:project/actiontrail_****",
  "MaxComputeWriteRoleArn": "acs:ram::151266687691****:role/aliyunserviceroleforactiontrail",
  "Name": "trail-test",
  "OssBucketName": "audit-log",
  "OssKeyPrefix": "at-product-account-audit-B",
  "OssWriteRoleArn": "acs:ram::151266687691****:role/aliyunserviceroleforactiontrail",
  "RequestId": "442DDADF-DA58-4029-8E8B-82C73E9A7A70",
  "SlsProjectArn": "acs:log:cn-hangzhou:151266687691****:project/test-project",
  "SlsWriteRoleArn": "acs:ram::151266687691****:role/aliyunserviceroleforactiontrail",
  "TrailRegion": "All"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidDeliveryConfigurationException	You must specify at least one Log Service project or OSS bucket for a Trail.
400	InvalidPrefixException	The specified OSS bucket prefix is invalid.	The specified OSS bucket prefix is not valid.
400	InvalidQueryParameter	The specified query parameter is invalid.	The specified query parameter is not valid.
400	InvalidTrailNameException	The specified Trail name is invalid.	The specified Trail name is not valid.
400	RepeatOssBucket	The specified OSS bucket is already in use. We recommend that you modify the existing Trail or specify another bucket.
400	SlsProjectDoesNotExistException	The specified Log Service project does not exist.
400	TrailAlreadyExistsException	The specified Trail name already exists.	The specified Trail name already exists,if you want to create a new Trail,please use another Trail name.
400	MaximumNumberOfOrganizationTrailExceeded	Your account can create only one organization trail.
400	NotAllowCreateOrganizationTrail	Your account does not allow you to create organization trail. Submit a ticket to get customer support.
403	InsufficientBucketPolicyException	Access to the specified OSS bucket was denied.
403	InsufficientSlsPolicyException	Access to the specified Log Service project was denied.	Access SLS Project denied.
403	MaximumNumberOfTrailsExceededException	The number of Trails in the same region exceeds the upper limit (5).	The number of Trail in same region has exceeded the limit 5
404	BucketDoesNotExistException	The specified OSS bucket does not exist.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.