GetDataEventSelector

Updated at:

Retrieves the details of the data event selector for a specified trail.

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:GetDataEventSelector

get

*Trail

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

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

TrailName

string

Yes

The name of the trail.

trail-name

Response elements

Element

Type

Description

Example

object

Schema of Response

DataEventSelectors

string

The data event selector configurations. The configurations are represented as a JSON array with a maximum size of 20.

Field descriptions for each element in the JSON array:

  • ServiceName: the name of the cloud service that supports data events.

  • ReadWriteType: Read, Write, or All.

  • EventName: contains two fields, Equals and NotEquals.

    For example, the following configuration specifies that only GetObject, CopyObject, and AppendObject events are delivered:

    {"EventName":{"Equals":["GetObject","CopyObject","AppendObject"]}}

    If NotEquals is used, events other than GetObject, CopyObject, and AppendObject are delivered.

  • ResourceArn: also contains two fields, Equals and NotEquals. Refer to EventName. Example:

    {"ResourceArn":{"Equals":[arn1,...,arnx]}}

[{"EventName":{"Equals":["GetObject","CopyObject","AppendObject"]},"ReadWriteType":"All","ServiceName":"Oss"}]

IsTrailAllRegion

boolean

Indicates whether the trail tracks events in all regions.

true

RequestId

string

The request ID.

90771C32-635B-529C-950C-75A9607D****

SlsDeliveryConfigs

array<object>

The list of Simple Log Service (SLS) delivery configurations.

object

The SLS delivery configuration object.

CreateTime

string

The creation time of the initialization record for the SLS delivery resource in the current region. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format and is displayed in UTC.

2024-12-18T03:25:36Z

ErrorCode

string

The error code returned when resource initialization fails.

LogServiceException

ErrorMessage

string

The error message returned when resource initialization fails.

RequestError Web request failed.

RegionSlsProjectArn

string

The ARN of the regional Simple Log Service project to which the trail delivers events.

acs:log:cn-shanghai:159498693826****:project/actiontrail-log-159498693826****-cn-shanghai

Status

string

The resource initialization status of the trail. Valid values:

  • success: The initialization succeeded.

  • failure: The initialization failed.

success

TrailRegion

string

The region tracked by the trail.

cn-shanghai

TrailArn

string

The ARN of the trail.

acs:actiontrail:cn-shanghai:159498693826****:trail/trail-name

In EventName, the total number of data elements in Equals and NotEquals cannot exceed 10. The same rule applies to ResourceArn.

Examples

Success response

JSON format

{
  "DataEventSelectors": "[{\"EventName\":{\"Equals\":[\"GetObject\",\"CopyObject\",\"AppendObject\"]},\"ReadWriteType\":\"All\",\"ServiceName\":\"Oss\"}]",
  "IsTrailAllRegion": true,
  "RequestId": "90771C32-635B-529C-950C-75A9607D****",
  "SlsDeliveryConfigs": [
    {
      "CreateTime": "2024-12-18T03:25:36Z",
      "ErrorCode": "LogServiceException",
      "ErrorMessage": "RequestError Web request failed.",
      "RegionSlsProjectArn": "acs:log:cn-shanghai:159498693826****:project/actiontrail-log-159498693826****-cn-shanghai",
      "Status": "success",
      "TrailRegion": "cn-shanghai"
    }
  ],
  "TrailArn": "acs:actiontrail:cn-shanghai:159498693826****:trail/trail-name"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.