获取通知消息列表

功能介绍

获取通知消息列表

URI

GET /v1/{project_id}/notices

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	华为云项目ID，您可以从获取项目ID中获取。最小长度：1 最大长度：128

表2 Query参数
参数	是否必选	参数类型	描述
is_read	否	Boolean	消息状态是否已读，true返回已读，false返回未读，不填返回全部
limit	否	Integer	查询条数最小值：1 最大值：1000 缺省值：100
offset	否	Integer	查询偏移量最小值：0 最大值：100000000 缺省值：0

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。最小长度：1 最大长度：32768

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total_count	Integer	通知消息总数
unread_count	Integer	通知消息未读总数
notices	Array of NoticeRsp objects	通知消息列表

表5 NoticeRsp
参数	参数类型	描述
id	String	消息id
type	String	消息类型
detail	String	消息详情
create_time	String	消息创建时间
is_read	Boolean	是否已读

请求示例

查询系统通知消息列表

https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/notices

响应示例

状态码： 200

{
  "total_count" : 100,
  "unread_count" : 50,
  "notices" : [ {
    "id" : 123456,
    "type" : "RESOURCE",
    "is_read" : true,
    "detail" : "notice detail",
    "create_time" : "2022-11-24 09:33:56"
  } ]
}