Help Center/ Host Security Service/ API Reference/ API Description/ Server Management/ ECS Risk Status
Updated on 2026-04-03 GMT+08:00
View PDF
Share

ECS Risk Status

Function

This API is used to query the ECS risk status.

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}/host-management/hosts-risk

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.

host_id_list

Yes

Array of strings

Server ID list.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total

data_list

Array of HostRiskResponseInfo objects

Querying the ECS risk list
Table 5 HostRiskResponseInfo

Parameter

Type

Description

host_id

String

Server ID

agent_status

String

Agent status. Its value can be:

  • not_installed

  • online

  • offline

  • install_failed

  • installing

install_result_code

String

Installation result. The options are as follows:

  • install_succeed

  • network_access_timeout: Connection timed out. Network error.

  • invalid_port

  • auth_failed: The authentication failed due to incorrect password.

  • permission_denied: Insufficient permissions.

  • no_available_vpc: There is no server with an online agent in the current VPC.

  • install_exception

  • invalid_param: Incorrect parameter.

  • install_failed

  • package_unavailable

  • os_type_not_support: Incorrect OS type

  • os_arch_not_support: Incorrect OS architecture

version

String

HSS edition. Its value can be:

  • hss.version.null: none

  • hss.version.basic: basic edition

  • hss.version.advanced: professional edition

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container.enterprise: container edition

protect_status

String

Protection status. It can be:

  • closed

  • opened

detect_result

String

Server scan result. The options are as follows:

  • undetected

  • clean: No risk is detected.

  • risk: Risks are detected.

  • scanning

asset

Integer

Asset risks

vulnerability

Integer

Vulnerabilities

baseline

Integer

Unsafe settings

intrusion

Integer

Intrusion risks

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "xxx",
    "agent_status" : "online",
    "install_result_code" : "install_succeed",
    "version" : "hss.version.basic",
    "protect_status" : "opened",
    "detect_result" : "clean",
    "asset" : 11,
    "vulnerability" : 11,
    "baseline" : 11,
    "intrusion" : 11
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Server Management