文档

DescribeTrails - 查询某地域的跟踪列表

更新时间:

查看已创建的跟踪列表。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
actiontrail:DescribeTrailsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
IncludeShadowTrailsboolean

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

  • false(默认值):不显示。
  • true:显示。
false
NameListstring

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

abc,def
IncludeOrganizationTrailboolean

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

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ED8BC689-69DA-42AC-855E-3B06C1271194
TrailListobject []

跟踪列表。

TrailRegionstring

跟踪的地域。

All
Statusstring

跟踪状态,取值:

  • Disable:停止。
  • Enable:开启。
  • Fresh:已创建跟踪,但未开启。
Enable
UpdateTimestring

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

2021-04-06T02:16:24Z
HomeRegionstring

跟踪的 Home 地域。

cn-hangzhou
CreateTimestring

跟踪创建的时间。

2021-03-01T06:27:28Z
OssKeyPrefixstring

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

trail1
EventRWstring

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

  • Write(默认值):写类型。
  • Read:读类型。
  • All:读类型和写类型。
All
StartLoggingTimestring

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

2021-04-06T02:08:38Z
OssWriteRoleArnstring

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

acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
SlsProjectArnstring

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

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

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

  • false(默认值):否。
  • true:是。
false
SlsWriteRoleArnstring

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

acs:ram::159498693826****:role/aliyunserviceroleforactiontrail
StopLoggingTimestring

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

2021-04-06T02:09:04Z
Namestring

跟踪名称。

test-4
OssBucketNamestring

OSS 存储空间的名称。

secloud
Regionstring

跟踪所在地域。

cn-hangzhou
OrganizationIdstring

资源目录 ID。

说明 只有多账号跟踪返回该参数。
rd-EV****
OssBucketLocationstring

OSS 存储空间所在地域。

oss-cn-hangzhou
TrailArnstring

跟踪的资源定位符。

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

操作审计向大数据计算服务项目投递操作事件时,扮演的角色 ARN。

acs:ram::151266687691****:role/aliyunserviceroleforactiontrail
MaxComputeProjectArnstring

跟踪投递的大数据计算服务项目的 ARN。

acs:odps:cn-hangzhou:151266687691****:project/actiontrail_****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidTrailNameExceptionThe specified Trail name is invalid.跟踪名称无效,请修改。
400InvalidQueryParameterThe specified query parameter is invalid.无效的查询参数。

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

变更历史

变更时间变更内容概要操作
2024-01-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2021-08-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)