调用DescribeTrails接口查询跟踪列表。

本文将提供一个示例,查询当前账号的单账号跟踪列表。返回结果显示只有一条名为test-4的跟踪。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeTrails

要执行的操作,取值DescribeTrails。

IncludeShadowTrails Boolean false

是否显示影子跟踪,取值:

  • false(默认值):不显示。
  • true:显示。
NameList String abc,def

需要查询的跟踪名称列表。多个名称之间用半角逗号(,)分隔。

IncludeOrganizationTrail Boolean false

是否查询多账号跟踪,取值:

  • true:查询多账号跟踪。
  • false(默认值):查询单账号跟踪。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
RequestId String ED8BC689-69DA-42AC-855E-3B06C1271194

请求ID。

TrailList Array of Trail

跟踪列表。

TrailRegion String All

跟踪的地域。

Status String Enable

跟踪状态,取值:

  • Stopped:停止。
  • Enable:开启。
  • Fresh:已创建跟踪,但未开启。
UpdateTime String 2021-04-06T02:16:24Z

跟踪配置最近一次更新的时间。

HomeRegion String cn-hangzhou

跟踪的Home地域。

CreateTime String 2021-03-01T06:27:28Z

跟踪创建的时间。

OssKeyPrefix String trail1

OSS存储空间文件名的前缀。

EventRW String All

投递事件的读写类型,取值:

  • Write(默认值):写类型。
  • Read:读类型。
  • All:读类型和写类型。
StartLoggingTime String 2021-04-06T02:08:38Z

最近一次开启跟踪的时间。

OssWriteRoleArn String acs:ram::***:role/aliyunserviceroleforactiontrail

操作审计向对象存储OSS存储空间投递操作事件时,扮演的角色ARN。

SlsProjectArn String acs:log:cn-qingdao:159498693826****:project/zhengze-audit-log

跟踪投递的日志服务项目的ARN。

IsOrganizationTrail Boolean false

是否是多账号跟踪,取值:

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

操作审计向日志服务项目投递操作事件时,扮演的角色ARN。

StopLoggingTime String 2021-04-06T02:09:04Z

最近一次停止跟踪的时间。

Name String test-4

跟踪名称。

OssBucketName String secloud

OSS存储空间的名称。

Region String cn-hangzhou

跟踪所在地域。

OrganizationId String rd-EV****

资源目录ID。

说明 只有多账号跟踪返回该参数。
OssBucketLocation String oss-cn-hangzhou

OSS存储空间所在地域。

TrailArn String acs:actiontrail:cn-hangzhou:159498693826****:trail/test-delivery-other

跟踪的资源定位符。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTrails
&<公共请求参数>

正常返回示例

JSON格式

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

{
  "RequestId" : "ED8BC689-69DA-42AC-855E-3B06C1271194",
  "TrailList" : [ {
    "Status" : "Disable",
    "HomeRegion" : "cn-hangzhou",
    "StartLoggingTime" : "2021-04-06T02:08:38Z",
    "CreateTime" : "2021-03-01T06:27:28Z",
    "StopLoggingTime" : "2021-04-06T02:09:04Z",
    "SlsWriteRoleArn" : "acs:ram::159498693826****:role/aliyunserviceroleforactiontrail",
    "OssBucketLocation" : "",
    "TrailRegion" : "All",
    "Name" : "test-4",
    "IsOrganizationTrail" : false,
    "SlsProjectArn" : "acs:log:cn-qingdao:159498693826****:project/zhengze-audit-log",
    "EventRW" : "All",
    "OssKeyPrefix" : "",
    "UpdateTime" : "2021-04-06T02:16:24Z",
    "Region" : "cn-hangzhou",
    "OssBucketName" : "",
    "OssWriteRoleArn" : "",
    "IsShadowTrail" : 0,
    "TrailArn" : "acs:actiontrail:cn-hangzhou:159498693826****:trail/test-delivery-other"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidTrailNameException The specified Trail name is invalid. 跟踪名称无效,请修改。
400 InvalidQueryParameter The specified query parameter is invalid. 无效的查询参数。

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