文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 安装配置/ 获取页面通知信息 - ShowPageNotices
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

获取页面通知信息 - ShowPageNotices

功能介绍

获取页面通知信息

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/setting/page-notices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

page_location

否

String

参数解释

访问页面位置

取值范围

  • hostMgmt：主机管理-云服务器

  • hostProtectQuota：主机管理-防护配额

  • containerNodeList：容器管理-容器节点管理

  • containerProtectQuota：容器管理-容器防护配额

  • containerMirror：容器管理-容器镜像

  • container：容器管理-容器

  • clusterAgent：容器管理-集群Agent管理

  • vulView：漏洞管理-漏洞视图

  • vulHostView：漏洞管理-主机视图

  • ransomwareProtection：勒索病毒防护

  • policyMgmt：策略管理

  • antiVirus：病毒查杀

  • hostAlarm：安全告警事件-主机安全告警

  • containerAlarm：安全告警事件-容器安全告警

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0，最大值2147483647

data_list

Array of ShowPageNoticesInfo objects

参数解释:

页面通知列表

取值范围:

最小值0，最大值200
表4 ShowPageNoticesInfo

参数

参数类型

描述

page_location

String

页面位置

type

String

通知类型，包含如下两种。

  • links：超链接

  • text：文本

content

String

通知内容

title

String

通知标题

url

String

超链接

level

String

参数解释

通知等级

取值范围

  • error：紧急

  • warn：重要

  • prompt：提示

请求示例

获取页面通知信息

GET https://{endpoint}/v5/{project_id}/setting/page-notices?enterprise_project_id=all_granted_eps

响应示例

状态码：200

请求已成功

{
  "total_num" : 10,
  "data_list" : [ {
    "page_location" : "hssOverview",
    "type" : "links",
    "content" : "test",
    "title" : "通知",
    "url" : "string",
    "level" : "error"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 安装配置

相关文档