GetTrailStatus - ActionTrail - Alibaba Cloud Documentation Center

Queries the status of a trail.

Operation description

This topic describes how to query the status of a sample single-account trail named trail-test.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
actiontrail:GetTrailStatus	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the trail. The name must be 6 to 36 characters in length. The name must start with a lowercase letter and can contain lowercase letters, digits, hyphens (-), and underscores (_). Note The name must be unique within your Alibaba Cloud account.	trail-test
IsOrganizationTrail	boolean	No	Specifies whether to query the status of a multi-account trail. Valid values: true: Query the status of a multi-account trail. false: Query the status of a single-account trail. It is the default value.	false

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	8067369B-B923-4D26-85BC-61BF33922505
StartLoggingTime	string	The time when logging was last enabled for the trail.	2021-02-24T09:19:44Z
LatestDeliveryError	string	The log of the last failed delivery.	write sls failed, exception: the parent of sub user must be project owner, itemscount: 1
StopLoggingTime	string	The time when logging was last disabled for the trail.	2021-02-25T09:19:44Z
IsLogging	boolean	Indicates whether logging is enabled for the trail. Valid values: true false	true
LatestDeliveryTime	string	The most recent time when an event was delivered by the trail.	2021-02-26T09:19:44Z
LatestDeliveryLogServiceError	string	The log of the last failed delivery to Log Service.	write sls failed, exception: the parent of sub user must be project owner, itemscount: 1
LatestDeliveryLogServiceTime	string	The most recent time when an event was delivered to Log Service.	2021-02-26T09:19:44Z
OssBucketStatus	boolean	Indicates whether the destination Object Storage Service (OSS) bucket is available. Valid values: true false	true
SlsLogStoreStatus	boolean	Indicates whether the destination Log Service Logstore is available. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "8067369B-B923-4D26-85BC-61BF33922505",
  "StartLoggingTime": "2021-02-24T09:19:44Z",
  "LatestDeliveryError": "write sls failed, exception: the parent of sub user must be project owner, itemscount: 1",
  "StopLoggingTime": "2021-02-25T09:19:44Z",
  "IsLogging": true,
  "LatestDeliveryTime": "2021-02-26T09:19:44Z",
  "LatestDeliveryLogServiceError": "write sls failed, exception: the parent of sub user must be project owner, itemscount: 1",
  "LatestDeliveryLogServiceTime": "2021-02-26T09:19:44Z",
  "OssBucketStatus": true,
  "SlsLogStoreStatus": true
}

Error codes

HTTP status code	Error code	Error message	Description
404	TrailNotFoundException	The specified Trail does not exist.	The specified Trail is not existed.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history