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 on each page
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
category	No	String	Type. The default value is host. The options are as follows: host container
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.

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
container_id	String	Container ID
container_name	String	Container name

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

Request succeeded.

{
  "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",
    "container_id" : "ce794b8a6-xxxx-xxxx-xxxxx-36bedf2c7a4f6083fb82e5bbc82709b50018",
    "container_name" : "hss_imagescan_W73V1WO6"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Asset Management

Previous topic: Querying Automatic Startup Item Information

Next topic: Querying the Open Port List of a Single Server

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot