CreateTrail - 创建跟踪 - 操作审计

操作审计默认为每个阿里云账号记录最近90天的事件。为了能够追溯90天以前的事件，您可以创建跟踪，将操作事件投递到对象存储OSS、日志服务SLS或大数据计算服务MaxCompute，以便对事件进行分析。

接口说明

说明通过 API 创建的跟踪默认处于已关闭状态，您需要调用接口 StartLogging 开启跟踪，操作审计才能投递操作事件至目标云产品。

前提条件

创建跟踪之前，请您确保至少完成下列的一项存储配置：

投递到对象存储 OSS

请确保您已开通对象存储，且已创建存储空间（Bucket）。
投递到日志服务 SLS

请确保您已开通日志服务，且已创建日志项目。

说明创建跟踪时，操作审计会自动在目标日志项目下创建一个名为actiontrail_<跟踪名称>的日志库（Logstore），该日志库禁止其他数据写入，保证审计数据的准确性。
投递到大数据计算服务 MaxCompute

请确保您已开通大数据计算服务 MaxCompute。

说明创建跟踪时，操作审计会自动在项目管理中创建一个名为actiontrail_<账号 ID>的项目，该项目禁止其他数据写入，保证审计数据的准确性。

使用说明

本文将提供一个示例，为您创建一个名为trail-test的单账号跟踪，将操作事件投递到名为audit-log的 OSS 存储空间中。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
actiontrail:CreateTrail	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	创建的跟踪名称。长度为 6～36 个字符，必须以小写英文字母开头，可包含小写英文字母、数字、短划线（-）和下划线（_）。说明同一个账号内跟踪名称不可重复。	trail-test
OssBucketName	string	否	跟踪投递的 OSS 存储空间。长度为 3～63 个字符，必须以小写英文字母或者数字开头，可包含小写英文字母、数字和短划线（-）。说明 OssBucketName、SlsProjectArn、MaxComputeProjectArn 需至少指定其中一个参数。	audit-log
OssKeyPrefix	string	否	跟踪投递的 OSS 存储空间文件名的前缀，可为空。长度为 6～32 个字符，必须以英文字母开头，可包含英文字母、数字、短划线（-）、正斜线（/）和下划线（_）。	at-product-account-audit-B
OssWriteRoleArn	string	否	操作审计向对象存储 OSS 存储空间投递操作事件时，扮演的角色 ARN。如果不指定该参数，操作审计会通过创建服务关联角色来创建相应的资源。更多信息，请参见操作审计服务关联角色。如果指定了该参数，当您需要将事件投递到本账号时，需要为 RAM 角色授予操作审计服务关联角色权限。当您需要将事件投递到其他账号时，需要为 RAM 角色绑定操作事件投递的系统权限策略。关于如何进行跨账号投递，请参见将多个阿里云账号的事件投递到同一账号。	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
SlsProjectArn	string	否	跟踪投递的日志服务项目的 ARN。说明 OssBucketName、SlsProjectArn、MaxComputeProjectArn 需至少指定其中一个参数。	acs:log:cn-shanghai:151266687691****:project/test-project
SlsWriteRoleArn	string	否	操作审计向日志服务项目投递操作事件时，扮演的角色 ARN。如果不指定该参数，操作审计会通过创建服务关联角色来创建相应的资源。更多信息，请参见操作审计服务关联角色。如果指定了该参数，当您需要将事件投递到本账号时，需要为 RAM 角色授予操作审计服务关联角色权限。当您需要将事件投递到其他账号时，需要为 RAM 角色绑定操作事件投递的系统权限策略。关于如何进行跨账号投递，请参见将多个阿里云账号的事件投递到同一账号。	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
EventRW	string	否	投递事件的读写类型，取值： Write（默认值）：写类型。 Read：读类型。 All：读类型和写类型。	Write
TrailRegion	string	否	跟踪的地域。默认值为 All，表示跟踪全部地域的事件。您也可以指定具体的地域。关于地域的更多信息，请调用 DescribeRegions 接口查询。	All
IsOrganizationTrail	boolean	否	是否创建多账号跟踪，取值： true：创建多账号跟踪。 false（默认值）：创建单账号跟踪。	false
MaxComputeProjectArn	string	否	跟踪投递的大数据计算服务项目的 ARN。说明 OssBucketName、SlsProjectArn、MaxComputeProjectArn 需至少指定其中一个参数。说明 MaxComputeProjectArn 中指定的大数据计算服务项目名称必须以 actiontrail_作为前缀。	acs:odps:cn-hangzhou:151266687691**:project/actiontrail_**
MaxComputeWriteRoleArn	string	否	操作审计向大数据计算服务项目投递操作事件时，扮演的角色 ARN。如果不指定该参数，操作审计会通过创建服务关联角色来创建相应的资源。更多信息，请参见操作审计服务关联角色。如果指定了该参数，当您需要将事件投递到本账号时，需要为 RAM 角色授予操作审计服务关联角色权限。当您需要将事件投递到其他账号时，需要为 RAM 角色绑定操作事件投递的系统权限策略。关于如何进行跨账号投递，请参见将多个阿里云账号的事件投递到同一账号。	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object
SlsProjectArn	string	跟踪投递的日志服务项目的 ARN。	acs:log:cn-hangzhou:151266687691****:project/test-project
OssWriteRoleArn	string	操作审计向对象存储 OSS 存储空间投递操作事件时，扮演的角色 ARN。	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
EventRW	string	投递事件的读写类型。	Write
RequestId	string	请求 ID。	442DDADF-DA58-4029-8E8B-82C73E9A7A70
HomeRegion	string	跟踪的 Home 地域。	cn-hangzhou
OssKeyPrefix	string	OSS 存储空间文件名的前缀。	at-product-account-audit-B
OssBucketName	string	OSS 存储空间。	audit-log
SlsWriteRoleArn	string	操作审计向日志服务项目投递操作事件时，扮演的角色 ARN。	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
TrailRegion	string	跟踪的地域。	All
Name	string	跟踪名称。	trail-test
MaxComputeProjectArn	string	跟踪投递的大数据计算服务项目的 ARN。	acs:odps:cn-hangzhou:151266687691**:project/actiontrail_**
MaxComputeWriteRoleArn	string	操作审计向大数据计算服务项目投递操作事件时，扮演的角色 ARN。	acs:ram::151266687691****:role/aliyunserviceroleforactiontrail

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDeliveryConfigurationException	You must specify at least one Log Service project or OSS bucket for a Trail.	跟踪至少指定一个投递的SLS Project或OSS Bucket。
400	InvalidPrefixException	The specified OSS bucket prefix is invalid.	指定的OSS前缀无效。
400	InvalidQueryParameter	The specified query parameter is invalid.	无效的查询参数。
400	InvalidTrailNameException	The specified Trail name is invalid.	跟踪名称无效，请修改。
400	RepeatOssBucket	The specified OSS bucket is already in use. We recommend that you modify the existing Trail or specify another bucket.	当前指定的OSS Bucket已经被使用，建议您修改之前的跟踪或指定新的Bucket。
400	SlsProjectDoesNotExistException	The specified Log Service project does not exist.	当前指定的SLS Project 不存在。
400	TrailAlreadyExistsException	The specified Trail name already exists.	您输入的跟踪名称已存在，如需创建新跟踪请修改跟踪名称。
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.	无法访问指定的OSS Bucket。
403	InsufficientSlsPolicyException	Access to the specified Log Service project was denied.	无法访问指定的SLS Project。
403	MaximumNumberOfTrailsExceededException	The number of Trails in the same region exceeds the upper limit (5).	同一地域最多可以创建5个跟踪。
404	BucketDoesNotExistException	The specified OSS bucket does not exist.	指定的OSS Bucket不存在。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-01-09	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情