Help Center/ Host Security Service/ API Reference/ API Description/ Installation and Configuration/ Obtaining Notifications on a Page
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Obtaining Notifications on a Page

Function

This API is used to obtain notifications on a page.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

page_location

No

String

Definition

Page access location

Range

  • hostMgmt: Servers & Quota - Servers

  • hostProtectQuota: Servers & Quota - Quotas

  • containerNodeList: Containers & Quota - Container Nodes

  • containerProtectQuota: Containers & Quota - Protection Quotas

  • containerMirror: Containers & Quota - Container Images

  • container: Containers & Quota - Containers

  • clusterAgent: Containers & Quota - Cluster Agents

  • vulView: Vulnerabilities - Vulnerability View

  • vulHostView: Vulnerabilities - Server View

  • ransomwareProtection: Ransomware Prevention

  • policyMgmt: Policies

  • antiVirus: Virus Scan

  • hostAlarm: Alarms - Server Alarms

  • containerAlarm: Alarms - Container Alarms

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number.

Range

The value range is 0 to 2,147,483,647.

data_list

Array of ShowPageNoticesInfo objects

Definition

Page notification list

Range

Minimum value: 0; maximum value: 200
Table 4 ShowPageNoticesInfo

Parameter

Type

Description

page_location

String

Page position

type

String

Notification type. The options are as follows:

  • links: hyperlink

  • text: text

content

String

Notification content.

title

String

Notification title.

url

String

Hyperlink

level

String

Definition

Level

Range

  • error: critical

  • warn: major

  • prompt: prompt

Example Requests

This API is used to obtain notifications on a page.

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

Example Responses

Status code: 200

Request succeeded.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Installation and Configuration