Query trail status using GetTrailStatus - ActionTrail - Alibaba Cloud - ActionTrail

Operation description

This topic provides an example on how to query the status of the single-account trail trail-test.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

actiontrail:GetTrailStatus

get

*Trail

acs:actiontrail:{#regionId}:{#accountId}:trail/{#TrailName}

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, must start with a lowercase letter, and can contain lowercase letters, digits, hyphens (-), and underscores (_). Note Trail names must be unique within an account.	trail-test
IsOrganizationTrail	boolean	No	Specifies whether to query the status of a multi-account trail. Valid values: true: queries the status of a multi-account trail. false (default): queries the status of a single-account trail.	false

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

Response elements

Element	Type	Description	Example
	object
IsLogging	boolean	Indicates whether log record is enabled. Valid values: true: Enabled. false: shutdown.	true
LatestDeliveryError	string	The log information of the most recent trail exception.	write sls failed, exception: the parent of sub user must be project owner, itemscount: 1
LatestDeliveryLogServiceError	string	The error message of the most recent fault during delivery to Simple Log Service.	write sls failed, exception: the parent of sub user must be project owner, itemscount: 1
LatestDeliveryLogServiceTime	string	The most recent time when the trail delivered events to Simple Log Service. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format in UTC.	2021-02-26T09:19:44Z
LatestDeliveryTime	string	The most recent time when events were successfully delivered. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format in UTC.	2021-02-26T09:19:44Z
OssBucketStatus	boolean	Indicates whether the OSS bucket is available. Valid values: true: Available. false: Not available.	true
RequestId	string	The request ID.	8067369B-B923-4D26-85BC-61BF33922505
SlsLogStoreStatus	boolean	Indicates whether the SLS Logstore is available. Valid values: true: Available. false: Not available.	true
StartLoggingTime	string	The most recent time when the trail started logging events. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format in UTC.	2021-02-24T09:19:44Z
StopLoggingTime	string	The most recent time when the trail stopped logging events. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format in UTC.	2021-02-25T09:19:44Z

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.