更新时间:2025-04-25 GMT+08:00
分享

查询事件模型列表

功能介绍

查询事件模型列表,包括系统事件模型和自定义事件模型

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/schemas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户资源空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询,偏移量不能小于0

limit

Integer

每页显示的条目数量,不能小于1或大于1000

sort

String

指定查询排序

provider_type

String

指定查询提供方的类型

name

String

指定查询的事件模型名称,精准匹配

fuzzy_name

String

指定查询的事件模型名称,模糊匹配

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

size

Integer

本页数量

items

Array of CustomizeSchemaItemInfo objects

对象列表

表5 CustomizeSchemaItemInfo

参数

参数类型

描述

id

String

事件模型ID

name

String

事件模型名称,租户下唯一

description

String

事件模型描述

compatibility

String

事件模型兼容性

provider_type

String

提供方类型,OFFICIAL:官方事件源;CUSTOM:自定义事件源

format

String

事件模型格式

number_of_versions

Integer

事件模型版本数

event_type_id

String

事件类型ID

event_type_name

String

事件类型名称

event_source_id

String

事件源ID

event_source_name

String

事件源名称

event_source_label

String

事件源标签

created_time

String

创建时间

updated_time

String

更新时间

请求示例

查询事件模型列表

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

响应示例

状态码:200

列表

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

状态码

状态码

描述

200

列表

错误码

请参见错误码

相关文档