Help Center/ EventGrid/ API Reference/ APIs/ Event Example Management/ Obtaining the Event Example List
Updated on 2025-05-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Event Example List

Function

This API is used to obtain the event example list.

URI

GET /v1/{project_id}/samples

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of records displayed on each page. The value must be within the range [1, 1000].

sort

No

String

Sorting mode of the query results.

name

No

String

Name of the event example. It is used for fuzzy match.

event_type_name

No

String

Event type name of the event example.

event_source_id

No

String

Event source of the event example.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number.

size

Integer

Number of records displayed on the current page.

items

Array of EventSampleItemInfo objects

Object list.
Table 5 EventSampleItemInfo

Parameter

Type

Description

id

String

Event example ID.

name

String

Event example name.

content

String

Event example content.

event_type_id

String

Event type ID corresponding to the event example.

event_type_name

String

Event type name corresponding to the event example.

event_source_id

String

Event source ID corresponding to the event example.

event_source_name

String

Name of the event source corresponding to the event example.

created_time

String

Creation time.

updated_time

String

Update time.

deleted_time

String

Deletion time.

Example Requests

Obtain the event example list.

GET https://{eg_endpoint}/v1/{project_id}/samples

Example Responses

Status code: 200

Operation successful.

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent topic: Event Example Management