Help Center/ Host Security Service/ API Reference/ API Description/ Asset Management/ Querying the Server List of an Account
Updated on 2025-09-22 GMT+08:00
View PDF

Querying the Server List of an Account

Function

This API is used to query the server list of an account.

URI

GET /v5/{project_id}/asset/users

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

host_id

No

String

Host ID

user_name

No

String

Account name

host_name

No

String

Host name

private_ip

No

String

Server private IP address

login_permission

No

Boolean

Whether login is allowed.

root_permission

No

Boolean

Whether the user has root permissions

user_group

No

String

Server user group

enterprise_project_id

No

String

Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.

limit

No

Integer

Number of records displayed on each page. The default value is 10.

offset

No

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token.

It can be obtained by calling the IAM API used to obtain an IAM token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of accounts

data_list

Array of UserResponseInfo objects

Account information list
Table 5 UserResponseInfo

Parameter

Type

Description

agent_id

String

Agent ID

host_id

String

Host ID

host_name

String

Server name

host_ip

String

Server IP address

user_name

String

Username

login_permission

Boolean

Whether the user has the login permission

root_permission

Boolean

Whether the user has root permissions

user_group_name

String

User group name

user_home_dir

String

User home directory

shell

String

User startup shell

recent_scan_time

Long

Latest scan time

Example Requests

Query servers list whose account is daemon by default.

GET https://{endpoint}/v5/{project_id}/asset/users?user_name=daemon

Example Responses

Status code: 200

account information list

{
  "total_num" : 1,
  "data_list" : [ {
    "agent_id" : "0bf792d910xxxxxxxxxxx52cb7e63exxx",
    "host_id" : "13xxxxxxxece69",
    "host_ip" : "192.168.0.1",
    "host_name" : "test",
    "login_permission" : false,
    "recent_scan_time" : 1667039707730,
    "root_permission" : false,
    "shell" : "/sbin/nologin",
    "user_group_name" : "bin",
    "user_home_dir" : "/bin",
    "user_name" : "bin"
  } ]
}

Status Codes

Status Code

Description

200

account information list

Error Codes

See Error Codes.

Parent Topic: Asset Management