Li, Qiao a5e72d5590 HSS API 20240206 version

Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>

2024-05-28 20:54:21 +00:00

17 KiB

Raw Permalink Blame History

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 Minimum: 1 Maximum: 128

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
host_id	No	String	Host ID Minimum: 0 Maximum: 128
user_name	No	String	Account name Minimum: 0 Maximum: 32
host_name	No	String	Host 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. true: Login is allowed. false: Login is not allowed.
root_permission	No	Boolean	Whether the user has root permissions true: The user has the root permission. false: The user does not have the root permission.
user_group	No	String	Server user group Minimum: 0 Maximum: 128
enterprise_project_id	No	String	Enterprise project ID. The value 0 indicates the default enterprise project. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 0 Maximum: 128
limit	No	Integer	Number of records on each page. Minimum: 10 Maximum: 200 Default: 10
offset	No	Integer	Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 2000000 Default: 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Minimum: 1 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number of accounts 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	Host 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
recent_scan_time	Long	Latest scan time, in ms. Minimum: 0 Maximum: 4070880000000

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

17 KiB Raw Permalink Blame History