edit-icon download-icon

DescribeTrails

Last Updated: Jul 22, 2018

Description

Retrieves settings for the trail associated with the current region.

Request parameters

Name Type Required Description
Action String Yes The parameter of the operation to perform: DescribeTrails.
NameList String No The list of trails to retrieve, which are separated by commas (,).
IncludeShadowTrails String No Whether shadow trail is displayed. The value can be true or false. The default value is false.

Response parameters

A JSON file of TrailList is returned. The content is as follows.

Name Type Description
Name String The trail name.
HomeRegion String The home region of the trail.
OssBucketName String The OSS bucket to which the trail delivers logs.
OssKeyPrefix String The prefix of the specified OSS bucket name.
RoleName String The RAM role.

Required permissions

Action

actiontrail:DescribeTrails

Resource

acs:actiontrail:${region}:${AccountId}:*

Error codes

Null.

Example

Request example

  1. http://actiontrail.cn-hangzhou.aliyuncs.com/actiontrail?
  2. &Action=DescribeTrails
  3. &NameList=abc%2cdef
  4. &<公共请求参数>

Response example

JSON example

  1. {
  2. "TrailList": [
  3. {
  4. "Name": "trail-test",
  5. "OssBucketName": "yuanchuang",
  6. "OssKeyPrefix": "",
  7. "RoleName": "aliyunactiontraildefaultrole"
  8. }
  9. ]
  10. }
Thank you! We've received your feedback.