更新时间:2024-06-27 GMT+08:00
分享

查询事件目标分类

功能介绍

查询预置的事件目标分类,获取每个事件目标分类的字段定义。

调试

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

URI

GET /v1/{project_id}/target-catalogs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

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

最小值:0

最大值:100

缺省值:0

limit

Integer

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

最小值:1

最大值:1000

缺省值:15

sort

String

指定查询排序

缺省值:created_time:DESC

fuzzy_label

String

指定查询的事件目标标签,模糊匹配

support_types

Array

事件目标支持方式:事件订阅:SUBSCRIPTION、事件流:FLOW

枚举值:

  • SUBSCRIPTION
  • FLOW

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:16384

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值:0

最大值:100

size

Integer

本页数量

最小值:0

最大值:100

items

Array of CatalogTargetInfo objects

对象列表

数组长度:0 - 100

表5 CatalogTargetInfo

参数

参数类型

描述

id

String

事件目标分类ID

name

String

事件目标分类名称

最小长度:1

最大长度:128

label

String

事件目标分类名称展示说明

最大长度:255

description

String

事件目标分类描述

最大长度:512

provider_type

String

提供方类型,OFFICIAL:官方云服务事件目标;CUSTOM:第三方事件目标

枚举值:

  • OFFICIAL
  • CUSTOM

parameters

Array of parameters objects

  

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

请求示例

响应示例

状态码: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

状态码: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

状态码: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

列表

400

非法请求

401

未授权

403

禁止访问

404

未找到资源

500

内部服务错误

错误码

请参见错误码

相关文档