Updates the configuration of a trail.

This topic shows you how to change the destination Object Storage Service (OSS) bucket of a sample trail named trail-test to audit-log.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateTrail

The operation that you want to perform. Set the value to UpdateTrail.

Name String Yes trail-test

The name of the trail for which you want to update the configuration.

The name must be 6 to 36 characters in length. The name must start with a lowercase letter and can contain lowercase letters, digits, hyphens (-), and underscores (_).

Note The name must be unique within your Alibaba Cloud account.
OssBucketName String No audit-log

The name of the OSS bucket to which events are to be delivered.

The name must be 3 to 63 characters in length. The name must start with a lowercase letter or a digit and can contain lowercase letters, digits, and hyphens (-).

Note Make sure that the bucket exists before you update the configuration of the trail.
OssKeyPrefix String No at-product-account-audit-B

The prefix of the log files to be stored in the destination OSS bucket.

The prefix must be 6 to 32 characters in length. The prefix must start with a letter and can contain letters, digits, hyphens (-), forward slashes (/), and underscores (_).

OssWriteRoleArn String No acs:ram::***:role/aliyunserviceroleforactiontrail

The Alibaba Cloud Resource Name (ARN) of the service-linked role that is assumed by ActionTrail to deliver events to the destination OSS bucket.

  • If you do not specify this parameter, ActionTrail creates a service-linked role to create the corresponding resource. For more information, see Manage the service-linked role.
  • If you specify this parameter, you must grant the permissions of the service-linked role that is assumed by ActionTrail to the RAM role before you can deliver events to your Alibaba Cloud account. If you need to deliver events to other Alibaba Cloud accounts, you must attach the permission policy that is used to grant permissions related to event delivery to the RAM role. For more information about how to deliver events across Alibaba Cloud accounts, see Aggregate events across Alibaba Cloud accounts.
SlsProjectArn String No acs:log:cn-shanghai::project/***

The ARN of the Log Service project to which events are to be delivered.

SlsWriteRoleArn String No acs:ram::***:role/aliyunserviceroleforactiontrail

The ARN of the service-linked role that is assumed by ActionTrail to deliver events to the destination Log Service project.

  • If you do not specify this parameter, ActionTrail creates a service-linked role to create the corresponding resource. For more information, see Manage the service-linked role.
  • If you specify this parameter, you must grant the permissions of the service-linked role that is assumed by ActionTrail to the RAM role before you can deliver events to your Alibaba Cloud account. If you need to deliver events to other Alibaba Cloud accounts, you must attach the permission policy that is used to grant permissions related to event delivery to the RAM role. For more information about how to deliver events across Alibaba Cloud accounts, see Aggregate events across Alibaba Cloud accounts.
EventRW String No All

The read/write type of the events to be delivered. Valid values:

  • Write: write events. It is the default value.
  • Read: read events.
  • All: read and write events.
TrailRegion String No All

The one or more regions from which the trail delivers events.

The default value is All, which indicates that the trail delivers events from all regions.

You can also specify specific regions. You can call the DescribeRegions operation to query all the supported regions.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
SlsProjectArn String acs:log:cn-hangzhou:151266687691****:project/test-project

The ARN of the Log Service project to which events are to be delivered.

OssWriteRoleArn String acs:ram::***:role/aliyunserviceroleforactiontrail

The ARN of the service-linked role that is assumed by ActionTrail to deliver events to the destination OSS bucket.

EventRW String Write

The read/write type of the events to be delivered.

RequestId String 2599A180-5236-44D8-9490-50B6F4F8BA35

The ID of the request.

HomeRegion String cn-hangzhou

The home region of the trail.

OssKeyPrefix String at-product-account-audit-B

The prefix of the log files to be stored in the destination OSS bucket.

OssBucketName String audit-log

The name of the OSS bucket to which events are to be delivered.

SlsWriteRoleArn String acs:ram::***:role/aliyunserviceroleforactiontrail

The ARN of the service-linked role that is assumed by ActionTrail to deliver events to the destination Log Service project.

TrailRegion String All

The one or more regions from which the trail delivers events.

Name String trail-test

The name of the trail.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateTrail
&Name=trail-test
&OssBucketName=audit-log
&<Common request parameters>

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SlsProjectArn" : "",
  "EventRW" : "All",
  "RequestId" : "2599A180-5236-44D8-9490-50B6F4F8BA35",
  "HomeRegion" : "cn-hangzhou",
  "OssKeyPrefix" : "",
  "OssBucketName" : "audit-log",
  "SlsWriteRoleArn" : "",
  "TrailRegion" : "All",
  "Name" : "trail-test"
}

Error codes

HTTP status code Error code Error message Description
400 IncompleteSignature The request signature does not conform to Alibaba Cloud standards. The error message returned because the request signature that is calculated by Alibaba Cloud does not match the signature that you provided. Check whether the AccessKey ID and AccessKey secret are valid and whether the signature method is appropriate. For more information, see Signature method.
400 InvalidPrefixException The specified OSS bucket prefix is invalid. The error message returned because the log file prefix specified for the destination OSS bucket is invalid.
403 InsufficientSlsPolicyException Access to the specified Log Service project was denied. The error message returned because you are not authorized to access the specified Log Service project.
404 TrailNotFoundException The specified Trail does not exist. The error message returned because the specified trail does not exist.

For a list of error codes, visit the API Error Center.