调用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

用于接收操作审计事件的MNS Topic的ARN，格式为：acs:mns:<Region>:<Account ID>:/topics/<topicName>。填写此参数后，向OSS中投递事件时，会产生一条消息投递到该MNS Topic。

RoleName String aliyunactiontraildefaultrole

用户允许操作审计服务扮演的RAM角色名称。
SlsProjectArn String acs:log:cn-hangzhou:159498693826****:project/alice-audit-log

跟踪投递目标的日志服务项目在阿里云唯一的资源名称（Aliyun Resource Name，ARN）。
IsOrganizationTrail Boolean false

是否是多账号跟踪，取值：

  • false（默认值）：否。
  • true：是。
SlsWriteRoleArn String acs:ram::159498693826****:role/aliyunserviceroleforactiontrail

操作审计向目标日志服务项目投递日志时，扮演的角色在阿里云唯一的资源名称（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. 无效的查询参数。

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