调用DescribeTrails接口查询某地域的跟踪列表。

调试

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

请求参数

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

要执行的操作，取值：DescribeTrails。
IncludeShadowTrails Boolean 否 true

是否显示影子跟踪，取值：

  • false（默认值）：不显示。
  • true：显示。
NameList String 否 abc,def

需要查询的跟踪名称列表，以半角逗号（,）分隔。

返回数据

名称 类型 示例值 描述
TrailList Array

跟踪列表。
CreateTime String 1581490216000

跟踪创建的时间。
EventRW String Write

投递事件的读写类型，取值：

  • Write（默认值）：写类型。
  • Read：读类型。
  • All：读类型和写类型。
HomeRegion String cn-hangzhou

跟踪的Home地域。
IsOrganizationTrail Boolean true

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

  • false（默认值）：否。
  • true：是。
MnsTopicArn String acs:mns:cn-hangzhou:1111:/topics/your-topic-name

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

Name String default

跟踪名称。

OssBucketName String secloud

OSS存储空间的名称。
OssKeyPrefix String trail1

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

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

跟踪投递目标的日志服务项目在阿里云唯一的资源名称（Aliyun Resource Name，ARN）。
SlsWriteRoleArn String acs:ram::***:role/aliyunactiontraildefaultrole

操作审计向目标日志服务项目投递日志时，扮演的角色在阿里云唯一的资源名称（Aliyun Resource Name，ARN）。
StartLoggingTime String Wed Dec 02 15:41:06 CST 2015

用户上一次开启该跟踪的时间。
Status String Enable

跟踪状态，取值：

  • Stopped：停止。
  • Enable：开启。
  • Fresh：已创建跟踪，但未开启。
StopLoggingTime String Wed Dec 03 15:41:06 CST 2015

用户上一次停止该跟踪的时间。
TrailRegion String All

跟踪的地域，取值示例：

  • All（默认值）：跟踪全部地域的事件。
  • cn-hangzhou ：仅跟踪杭州地域的事件 。
  • cn-beijing：仅跟踪北京地域的事件。
UpdateTime String 1581490242000

跟踪配置上次更新的时间。
RequestId String 145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0

请求ID。

示例

请求示例

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

正常返回示例

XML 格式 

<TrailList>
    <Name>default</Name>
    <OssBucketName>secloud</OssBucketName>
    <OssKeyPrefix>trail1</OssKeyPrefix>
    <RoleName>aliyunactiontraildefaultrole</RoleName>
    <SlsProjectArn>acs:log:cn-shanghai::project/***</SlsProjectArn>
    <SlsWriteRoleArn>acs:ram::***:role/aliyunactiontraildefaultrole</SlsWriteRoleArn>
</TrailList>
<RequestId>145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0</RequestId>

JSON 格式 

{
  "TrailList": [
    {
      "Name": "default",
      "OssBucketName": "secloud",
      "OssKeyPrefix": "trail1",
      "RoleName": "aliyunactiontraildefaultrole",
      "SlsProjectArn":"acs:log:cn-shanghai::project/***",
      "SlsWriteRoleArn":"acs:ram::***:role/aliyunactiontraildefaultrole"
    }
  ],
  "RequestId":"145318BE-DEE1-4C57-AA7C-5BE7D34A6AE0"
}

错误码

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

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