全部產品
Search
文件中心

ActionTrail:DescribeTrails

更新時間:Jan 16, 2025

調用DescribeTrails介面查詢某地區的跟蹤列表。

本文將提供一個樣本,查詢當前帳號的單帳號跟蹤列表。返回結果顯示只有一條名為test-4的跟蹤。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String DescribeTrails

要執行的操作,取值:DescribeTrails。

IncludeShadowTrails Boolean true

是否顯示影子跟蹤,取值:

  • false(預設值):不顯示。
  • true:顯示。
NameList String audit-log,trail-test2

需要查詢的跟蹤名稱列表,以半形逗號(,)分隔。

IncludeOrganizationTrail Boolean false

是否查詢多帳號跟蹤。取值:

  • true:查詢多帳號跟蹤。
  • false(預設值):不查詢多帳號跟蹤,即查詢單帳號跟蹤。

返回資料

名稱 類型 樣本值 描述
RequestId String 10313D41-C40A-4D53-ACA0-0190334DF81C

請求ID。

TrailList Array of TrailList

跟蹤列表。

TrailRegion String All

跟蹤的地區,取值樣本:

  • All(預設值):跟蹤全部地區的事件。
  • cn-hangzhou :僅跟蹤杭州地區的事件 。
  • cn-beijing:僅跟蹤北京地區的事件。
Status String Enable

跟蹤狀態,取值:

  • Disable:停止。
  • Enable:開啟。
  • Fresh:已建立跟蹤,但未開啟。
UpdateTime String 1619407012000

跟蹤配置上次更新的時間。

HomeRegion String cn-hangzhou

跟蹤的Home地區。

CreateTime String 1614580048000

跟蹤建立的時間。

OssKeyPrefix String trail1

OSS儲存空間檔案名稱的首碼。

EventRW String Write

投遞事件的讀寫類型,取值:

  • Write(預設值):寫類型。
  • Read:讀類型。
  • All:讀類型和寫類型。
StartLoggingTime String 1619407012000

使用者上一次開啟該跟蹤的時間。

MnsTopicArn String acs:mns:cn-hangzhou:1111:/topics/your-topic-name

用於接收Action Trail事件的MNS Topic的ARN,格式為:acs:mns:<Region>:<Account ID>:/topics/<topicName>。填寫此參數後,向OSS中投遞事件時,會產生一條訊息投遞到該MNS Topic。

RoleName String aliyunactiontraildefaultrole

使用者允許Action Trail服務扮演的RAM角色名稱。

SlsProjectArn String acs:log:cn-hangzhou:159498693826****:project/alice-audit-log

跟蹤投遞目標的Log Service專案在阿里雲唯一的資源名稱(Aliyun Resource Name,ARN)。

IsOrganizationTrail Boolean false

是否是多帳號跟蹤,取值:

  • false(預設值):否。
  • true:是。
SlsWriteRoleArn String acs:ram::159498693826****:role/aliyunserviceroleforactiontrail

Action Trail向目標Log Service專案投遞日誌時,扮演的角色在阿里雲唯一的資源名稱(Aliyun Resource Name,ARN)。

StopLoggingTime String 1617674944000

使用者上一次停止該跟蹤的時間。

Name String test-4

跟蹤名稱。

OssBucketName String secloud

OSS儲存空間的名稱。

樣本

請求樣本

http(s)://[Endpoint]/?Action=DescribeTrails
&公用請求參數

正常返回樣本

XML格式

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

<DescribeTrailsResponse>
    <RequestId>10313D41-C40A-4D53-ACA0-0190334DF81C</RequestId>
    <TrailList>
        <Status>Enable</Status>
        <MnsTopicArn>acs:mns:cn-hangzhou:1111:/topics/your-topic-name</MnsTopicArn>
        <HomeRegion>cn-hangzhou</HomeRegion>
        <StartLoggingTime>1619407012000</StartLoggingTime>
        <CreateTime>1614580048000</CreateTime>
        <StopLoggingTime>1617674944000</StopLoggingTime>
        <SlsWriteRoleArn>acs:ram::159498693826****:role/aliyunserviceroleforactiontrail</SlsWriteRoleArn>
        <TrailRegion>All</TrailRegion>
        <Name>test-4</Name>
        <IsOrganizationTrail>false</IsOrganizationTrail>
        <SlsProjectArn>acs:log:cn-hangzhou:159498693826****:project/alice-audit-log</SlsProjectArn>
        <RoleName>aliyunactiontraildefaultrole</RoleName>
        <EventRW>Write</EventRW>
        <UpdateTime>1619407012000</UpdateTime>
        <OssKeyPrefix>trail1</OssKeyPrefix>
        <OssBucketName>secloud</OssBucketName>
    </TrailList>
</DescribeTrailsResponse>

JSON格式

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

{
  "RequestId" : "10313D41-C40A-4D53-ACA0-0190334DF81C",
  "TrailList" : [ {
    "Status" : "Enable",
    "MnsTopicArn" : "acs:mns:cn-hangzhou:1111:/topics/your-topic-name",
    "HomeRegion" : "cn-hangzhou",
    "StartLoggingTime" : 1619407012000,
    "CreateTime" : 1614580048000,
    "StopLoggingTime" : 1617674944000,
    "SlsWriteRoleArn" : "acs:ram::159498693826****:role/aliyunserviceroleforactiontrail",
    "TrailRegion" : "All",
    "Name" : "test-4",
    "IsOrganizationTrail" : false,
    "SlsProjectArn" : "acs:log:cn-hangzhou:159498693826****:project/alice-audit-log",
    "RoleName" : "aliyunactiontraildefaultrole",
    "EventRW" : "Write",
    "UpdateTime" : 1619407012000,
    "OssKeyPrefix" : "trail1",
    "OssBucketName" : "secloud"
  } ]
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 InvalidTrailNameException The specified Trail name is invalid. 跟蹤名稱無效,請修改。
400 InvalidQueryParameter The specified query parameter is invalid. 無效的查詢參數。

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