CreateTrail - 操作审计

您可以创建跟踪，将操作事件分别投递到日志服务SLS或对象存储OSS，或者同时进行投递。创建跟踪前请进行以下操作：

投递到日志服务SLS：请确保您已经创建SLS的Project。

说明投递成功后操作审计会自动创建一个名为actiontrail_<跟踪名称>的日志库（Logstore），该Logstore会自动帮您设置审计最佳配置，创建查询所需索引和仪表盘，并禁止用户写入，保证审计数据的准确性。您无需提前创建Logstore。
投递到对象存储OSS：请确保您已经创建对象存储OSS的存储空间。

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

调试

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

请求参数


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

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

返回数据


名称	类型	示例值	描述
MnsTopicArn	String	acs:mns:cn-hangzhou:1111:/topics/your-topic-name	用于接收操作审计事件的MNS Topic的ARN。
SlsProjectArn	String	acs:log:cn-hangzhou:151266687691****:project/test-project	跟踪投递的日志服务项目的ARN。
RoleName	String	aliyunserviceroleforactiontrail	操作审计服务关联角色名称。
EventRW	String	Write	投递事件的读写类型。
RequestId	String	145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0	请求ID。
HomeRegion	String	cn-hangzhou	跟踪的Home地域。
OssKeyPrefix	String	at-product-account-audit-B	OSS存储空间文件名的前缀。
OssBucketName	String	audit-log	OSS存储空间。
SlsWriteRoleArn	String	acs:ram::***:role/aliyunserviceroleforactiontrail	操作审计向日志服务项目投递操作事件时，扮演的角色ARN。
TrailRegion	String	All	跟踪的地域。
Name	String	trail-test	跟踪名称。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTrail
&Name=trail-test
&OssBucketName=audit-log
&<公共请求参数>

正常返回示例

XML格式

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

<CreateTrailResponse>
    <RoleName>aliyunserviceroleforactiontrail</RoleName>
    <EventRW>Write</EventRW>
    <RequestId>AB7A5AE1-EC3C-4C00-91B0-BE7BDEE354AE</RequestId>
    <HomeRegion>cn-hangzhou</HomeRegion>
    <OssBucketName>audit-log</OssBucketName>
    <TrailRegion>All</TrailRegion>
    <Name>trail-test</Name>
</CreateTrailResponse>

JSON格式

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

{
  "RoleName" : "aliyunserviceroleforactiontrail",
  "EventRW" : "Write",
  "RequestId" : "AB7A5AE1-EC3C-4C00-91B0-BE7BDEE354AE",
  "HomeRegion" : "cn-hangzhou",
  "OssBucketName" : "audit-log",
  "TrailRegion" : "All",
  "Name" : "trail-test"
}

错误码


HttpCode	错误码	错误信息	描述
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	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	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个跟踪。

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