调用CreateTrail接口创建跟踪。

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

  • 投递到日志服务SLS:请确保您已经创建SLS的Project。
  • 投递到对象存储OSS:请确保您已经创建对象存储OSS的存储空间。具体操作,请参见创建存储空间

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateTrail

要执行的操作,取值CreateTrail。

Name String trail-test

创建的跟踪名称。

长度为6~36个字符,必须以英文字母开头,可包含英文字母、数字、短划线(-)和下划线(_)。

说明 同一个账号内跟踪名称不可重复。
OssBucketName String auditB

跟踪投递的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。

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 auditB

OSS存储空间。

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

操作审计向日志服务项目投递操作事件时,扮演的角色ARN。

TrailRegion String All

跟踪的地域。

Name String trail-test

跟踪名称。

示例

请求示例

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

正常返回示例

JSON格式

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

{
  "RoleName" : "aliyunserviceroleforactiontrail",
  "EventRW" : "Write",
  "RequestId" : "AB7A5AE1-EC3C-4C00-91B0-BE7BDEE354AE",
  "HomeRegion" : "cn-hangzhou",
  "OssBucketName" : "auditB",
  "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个跟踪。

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