查询事件目标分类 - ListEventTarget
功能介绍
查询预置的事件目标分类,获取每个事件目标分类的字段定义。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/target-catalogs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户资源空间ID |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 偏移量,表示从此偏移量开始查询,偏移量不能小于0 |
| limit | 否 | Integer | 每页显示的条目数量,不能小于1或大于1000 |
| sort | 否 | String | 指定查询排序 |
| fuzzy_label | 否 | String | 指定查询的事件目标标签,模糊匹配 |
| support_types | 否 | Array of strings | 事件目标支持方式:事件订阅:SUBSCRIPTION、事件流:FLOW |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 总数 |
| size | Integer | 本页数量 |
| items | Array of CatalogTargetInfo objects | 对象列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 事件目标分类ID |
| name | String | 事件目标分类名称 |
| label | String | 事件目标分类名称展示说明 |
| description | String | 事件目标分类描述 |
| provider_type | String | 提供方类型,OFFICIAL:官方云服务事件目标;CUSTOM:第三方事件目标 |
| parameters | Array of CatalogTargetParameters objects | 事件目标分类参数 |
| created_time | String | 创建UTC时间 |
| updated_time | String | 更新UTC时间 |
请求示例
查询事件目标分类
GET https://{endpoint}/v1/{project_id}/target-catalogs 响应示例
状态码:200
列表
{
"total" : 1,
"size" : 1,
"items" : [ { } ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 列表 |
错误码
请参见错误码。