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

Obtaining the Event Schema Version List

Function

This API is used to obtain the list of event schema versions.

URI

GET /v1/{project_id}/schemas/{schema_id}/versions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.

schema_id

Yes

String

ID of the event schema.
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.

version

No

String

Version of the event schema.

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 of records.

size

Integer

Number of records displayed on the current page.

items

Array of CustomizeSchemaVersionItemInfo objects

Object list.
Table 5 CustomizeSchemaVersionItemInfo

Parameter

Type

Description

id

String

ID of the event schema version.

version

Integer

Version number of the event schema.

created_time

String

Time when the event schema is created.

updated_time

String

Time when the event schema is updated.

Example Requests

Obtain the event schema version list.

GET https://{endpoint}/v1/{project_id}/schemas/{schema_id}/versions

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 Schema Management