更新时间:2024-05-07 GMT+08:00
分享

查询通知列表

功能介绍

本接口用于查询通知列表。

调用方法

请参见如何调用API

URI

GET /v1/agents/{agent_id}/notices

表1 路径参数

参数

是否必选

参数类型

描述

agent_id

String

可信计算节点id。 支持数字,英文字母,下划线,长度32。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

起始位置,取值0-2147483647。取值为0时系统默认返回第1页,与取值为1相同。

缺省值:0

limit

Integer

查询个数,查询返回通知消息的个数,取值0-100,默认值位0。

缺省值:10

filter

String

过滤条件,可用于删选通知,筛选的雕件可选择为空间创建人或者空间名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用接口获取用户Token接口获取。

X-Language

String

根据自己偏好的语言来获取不同语言的返回内容,zh-cn或者en_us

Content-Type

String

消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Long

总个数

最小值:0

最大值:9223372036854775807

lists

Array of NoticeListVo objects

通知列表

数组长度:0 - 100

表5 NoticeListVo

参数

参数类型

描述

id

String

通知记录id。 支持数字,英文字母,下划线,长度32。

最小长度:0

最大长度:32

notice_type

String

通知类型

枚举值:

  • DATASET_USE_APPROVAL

creator_partner_alias

String

通知创建者别名

最小长度:0

最大长度:128

notice_status

String

通知处理状态

枚举值:

  • OPEN

  • DONE

  • REVOKED

create_time

String

创建时间

handle_time

String

处理时间

请求示例

查询通知列表

get https://100.1.1.1:31000/v1/agents/{agent_id}/notices?offset=0&limit=10

响应示例

状态码: 200

查询通知列表成功

{
  "total" : 1,
  "lists" : [ {
    "id" : "3a6e70c4b3a849fa9faffc480c903c9b",
    "notice_type" : "DATASET_USE_APPROVAL",
    "creator_partner_alias" : "space_creator",
    "notice_status" : "OPEN"
  } ],
  "create_time" : "2022-02-25T03:12:09.296+00:00"
}

状态码

状态码

描述

200

查询通知列表成功

401

操作无权限

500

内部服务器错误

相关文档