全部產品
Search

搜尋本產品

    ActionTrail：CreateTrail

    文件中心

    ActionTrail：CreateTrail

    更新時間：Jan 16, 2025

    調用CreateTrail介面建立跟蹤。

    您可以建立跟蹤，將操作事件分別投遞到Log ServiceSLS或Object Storage Service，或者同時進行投遞。建立跟蹤前請進行以下操作：

    • 投遞到Log ServiceSLS：請確保您已經建立SLS的Project。
      說明 投遞成功後Action Trail會自動建立一個名為actiontrail_<跟蹤名稱>的日誌庫（Logstore），該Logstore會自動幫您設定審計最佳配置，建立查詢所需索引和儀錶盤，並禁止使用者寫入，保證審計資料的準確性。您無需提前建立Logstore。
    • 投遞到Object Storage Service：請確保您已經建立Object Storage Service的儲存空間。

    本文將提供一個樣本，為您建立一個名為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

    Action Trail服務關聯角色名稱，預設值：aliyunserviceroleforactiontrail。
    SlsProjectArn String 否 acs:log:cn-shanghai::project/***

    跟蹤投遞的Log Service專案的ARN。

    說明 OssBucketName和SlsProjectArn需至少指定其中一個參數。
    SlsWriteRoleArn String 否 acs:ram::***:role/aliyunserviceroleforactiontrail

    Action Trail向Log Service專案投遞操作事件時，扮演的角色ARN。

    • 如果不指定該參數，Action Trail會通過建立服務關聯角色來建立相應的資源。更多資訊，請參見Action Trail服務關聯角色。
    • 如果指定了該參數，當您需要將事件投遞到本帳號時，需要為RAM角色授予Action Trail服務關聯角色許可權。當您需要將事件投遞到其他帳號時，需要為RAM角色綁定操作事件投遞的系統權限原則。關於如何進行跨帳號投遞，請參見將多個阿里雲帳號的事件投遞到同一帳號。
    EventRW String 否 Write

    投遞事件的讀寫類型，取值：

    • Write（預設值）：寫類型。
    • Read：讀類型。
    • All：讀類型和寫類型。
    TrailRegion String 否 All

    跟蹤的地區。

    預設值為All，表示跟蹤全部地區的事件。

    您也可以指定具體的地區。關於地區的更多資訊，請調用DescribeRegions介面查詢。
    MnsTopicArn String 否 acs:mns:cn-hangzhou:1111:/topics/your-topic-name

    用於接收Action Trail事件的Message ServiceMNS 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

    用於接收Action Trail事件的MNS Topic的ARN。

    SlsProjectArn String acs:log:cn-hangzhou:151266687691****:project/test-project

    跟蹤投遞的Log Service專案的ARN。
    RoleName String aliyunserviceroleforactiontrail

    Action Trail服務關聯角色名稱。
    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

    Action Trail向Log Service專案投遞操作事件時，扮演的角色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個跟蹤。

    訪問錯誤中心查看更多錯誤碼。