调用CreateTrail接口创建跟踪。
您可以根据需要选择合适的投递目标,例如日志服务(推荐)或OSS存储空间。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateTrail |
要执行的操作,取值:CreateTrail。 |
Name | String | 是 | trail-test |
创建的跟踪名称。 长度为6~36个字符,必须以英文字母开头,可包含英文字母、数字、短划线(-)和下划线(_)。 说明 同一个账号内跟踪名称不可重复。
|
RoleName | String | 是 | aliyunactiontraildefaultrole |
用户允许操作审计服务扮演的RAM角色名称,默认值:aliyunactiontraildefaultrole。 |
OssBucketName | String | 否 | yuanch**** |
跟踪写入的OSS存储空间。 长度为3~63个字符,必须以小写英文字母或者数字开头,可包含小写英文字母、数字和短划线(-)。 说明 创建跟踪时必须确保该存储空间已经存在。
|
OssKeyPrefix | String | 否 | at-product-account-audit-B |
跟踪写入的OSS存储空间文件名的前缀,可为空。 长度为6~32个字符,必须以英文字母开头,可包含英文字母、数字、短划线(-)、正斜线(/)和下划线(_)。 |
SlsProjectArn | String | 否 | acs:log:cn-shanghai::project/*** |
跟踪投递目标的日志服务项目在阿里云唯一的资源名称(Aliyun Resource Name,ARN)。 |
SlsWriteRoleArn | String | 否 | acs:ram::***:role/aliyunactiontraildefaultrole |
操作审计向目标日志服务项目投递日志时,扮演的角色在阿里云唯一的资源名称(Aliyun Resource Name,ARN)。 |
EventRW | String | 否 | Write |
投递事件的读写类型,取值:
|
TrailRegion | String | 否 | All |
跟踪的地域,取值示例:
|
MnsTopicArn | String | 否 | acs:mns:cn-hangzhou:1111:/topics/your-topic-name |
用于接收操作审计事件的MNS Topic的ARN,格式为: |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | trail-test |
用户允许操作审计服务扮演的RAM角色名称。 |
EventRW | String | Write |
投递事件的读写类型,取值:
|
HomeRegion | String | cn-hangzhou |
跟踪的Home地域。 |
OssBucketName | String | yuanch**** |
用户指定的OSS存储空间。 |
OssKeyPrefix | String | at-product-account-audit-B |
用户指定的OSS存储空间文件名的前缀,可为空。 |
RoleName | String | aliyunactiontraildefaultrole |
用户指定的RAM角色名称。 |
SlsWriteRoleArn | String | acs:ram::***:role/aliyunactiontraildefaultrole |
操作审计向目标日志服务项目投递日志时,扮演的角色在阿里云唯一的资源名称(Aliyun Resource Name,ARN)。 |
SlsProjectArn | String | acs:log:cn-shanghai::project/*** |
跟踪投递目标的日志服务项目在阿里云唯一的资源名称(Aliyun Resource Name,ARN)。 |
RequestId | String | 145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0 |
请求ID。 |
MnsTopicArn | String | acs:mns:cn-hangzhou:1111:/topics/your-topic-name |
用于接收操作审计事件的MNS Topic的ARN,格式为: |
TrailRegion | String | All |
跟踪的地域,取值示例:
|
示例
请求示例
http(s)://[Endpoint]/?Action=CreateTrail
&Name=trail-test
&RoleName=aliyunactiontraildefaultrole
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
<Name>trail-test</Name>
<HomeRegion>cn-hangzhou</HomeRegion>
<OssBucketName>yuanch****</OssBucketName>
<OssKeyPrefix>at-product-account-audit-B</OssKeyPrefix>
<RoleName>aliyunactiontraildefaultrole</RoleName>
<SlsProjectArn>acs:log:cn-shanghai::project/***</SlsProjectArn>
<SlsWriteRoleArn>acs:ram::***:role/aliyunactiontraildefaultrole</SlsWriteRoleArn>
JSON
格式
{
"RequestId":"04F0F334-1335-436C-A1D7-6C044FE73368",
"Name": "trail-test",
"HomeRegion": "cn-hangzhou",
"OssBucketName": "yuanch****",
"OssKeyPrefix": "at-product-account-audit-B",
"RoleName": "aliyunactiontraildefaultrole",
"SlsProjectArn":"acs:log:cn-shanghai::project/***",
"SlsWriteRoleArn":"acs:ram::***:role/aliyunactiontraildefaultrole"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | BucketDoesNotExistException | The specified OSS bucket does not exist. | 指定的OSS bucket不存在。 |
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。 |
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. | 跟踪名称无效,请修改 |
403 | MaximumNumberOfTrailsExceededException | The number of Trails in the same region exceeds the upper limit (5). | 同一Region最多可以创建5个跟踪。 |
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. | 跟踪名称已存在,请修改。 |
访问错误中心查看更多错误码。