Querying the Server List of an Account
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 1 Maximum: 128 |
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 |
root_permission |
No |
Boolean |
Whether the user has root permissions |
user_group |
No |
String |
Server 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 |
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 |
category |
No |
String |
Type. The default value is host. The options are as follows:
Minimum: 0 Maximum: 64 |
part_match |
No |
Boolean |
Whether fuzzy match is used. The default value is false. |
Request 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
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 |
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 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, "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" } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListUsersSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListUsersRequest request = new ListUsersRequest(); request.withHostId("<host_id>"); request.withUserName("<user_name>"); request.withHostName("<host_name>"); request.withPrivateIp("<private_ip>"); request.withLoginPermission(<login_permission>); request.withRootPermission(<root_permission>); request.withUserGroup("<user_group>"); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withCategory("<category>"); request.withPartMatch(<part_match>); try { ListUsersResponse response = client.listUsers(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListUsersRequest() request.host_id = "<host_id>" request.user_name = "<user_name>" request.host_name = "<host_name>" request.private_ip = "<private_ip>" request.login_permission = <LoginPermission> request.root_permission = <RootPermission> request.user_group = "<user_group>" request.enterprise_project_id = "<enterprise_project_id>" request.limit = <limit> request.offset = <offset> request.category = "<category>" request.part_match = <PartMatch> response = client.list_users(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListUsersRequest{} hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest userNameRequest:= "<user_name>" request.UserName = &userNameRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest privateIpRequest:= "<private_ip>" request.PrivateIp = &privateIpRequest loginPermissionRequest:= <login_permission> request.LoginPermission = &loginPermissionRequest rootPermissionRequest:= <root_permission> request.RootPermission = &rootPermissionRequest userGroupRequest:= "<user_group>" request.UserGroup = &userGroupRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest categoryRequest:= "<category>" request.Category = &categoryRequest partMatchRequest:= <part_match> request.PartMatch = &partMatchRequest response, err := client.ListUsers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Account information list |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot