Querying the Server List of an Account

Updated on 2024-01-31 GMT+08:00

View PDF

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/asset/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User project ID Minimum: 1 Maximum: 128

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
host_id	No	String	Server ID Minimum: 0 Maximum: 128
user_name	No	String	Account name Minimum: 0 Maximum: 32
host_name	No	String	Server name Minimum: 0 Maximum: 128
private_ip	No	String	Server private IP address Minimum: 0 Maximum: 128
login_permission	No	Boolean	Whether login is allowed.
root_permission	No	Boolean	Whether the user has root permissions
user_group	No	String	User group Minimum: 0 Maximum: 128
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Minimum: 0 Maximum: 128
limit	No	Integer	Default value: 10 Minimum: 10 Maximum: 200 Default: 10
offset	No	Integer	Default value: 0 Minimum: 0 Maximum: 2000000 Default: 0
category	No	String	Type. The default value is host. The options are as follows: host container Minimum: 0 Maximum: 64
part_match	No	Boolean	Whether fuzzy match is used. The default value is false.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number Minimum: 0 Maximum: 10000
data_list	Array of UserResponseInfo objects	Account information list Array Length: 0 - 10000

**Table 5** UserResponseInfo
Parameter	Type	Description
agent_id	String	agent_id Minimum: 1 Maximum: 128
host_id	String	Server ID Minimum: 1 Maximum: 128
host_name	String	Server name Minimum: 1 Maximum: 128
host_ip	String	Server IP address Minimum: 1 Maximum: 128
user_name	String	Username Minimum: 1 Maximum: 128
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 Minimum: 1 Maximum: 128
user_home_dir	String	User home directory Minimum: 1 Maximum: 256
shell	String	User startup shell Minimum: 1 Maximum: 128
expire_time	Long	Expiration time, which is a timestamp. The default unit is millisecond. Minimum: 0 Maximum: 4070880000000
recent_scan_time	Long	Latest scan time Minimum: 0 Maximum: 4070880000000
container_id	String	Container ID Minimum: 1 Maximum: 128
container_name	String	Container name Minimum: 1 Maximum: 256

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,
    "expire_time" : 1667039707730,
    "root_permission" : false,
    "shell" : "/sbin/nologin",
    "user_group_name" : "bin",
    "user_home_dir" : "/bin",
    "user_name" : "bin",
    "container_id" : "ce794b8a6-xxxx-xxxx-xxxxx-36bedf2c7a4f6083fb82e5bbc82709b50018",
    "container_name" : "hss_imagescan_W73V1WO6"
  } ]
}