調用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。
|
EventRW | String | 否 | Write |
投遞事件的讀寫類型,取值:
|
TrailRegion | String | 否 | All |
跟蹤的地域。 默認值為All,表示跟蹤全部地域的事件。 您也可以指定具體的地域。關于地域的更多信息,請調用DescribeRegions接口查詢。 |
MnsTopicArn | String | 否 | acs:mns:cn-hangzhou:1111:/topics/your-topic-name |
用于接收操作審計事件的消息服務MNS Topic的ARN,格式為: |
IsOrganizationTrail | Boolean | 否 | 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個跟蹤。 |
訪問錯誤中心查看更多錯誤碼。