查询账号的服务器列表
功能介绍
查询账号的服务器列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/asset/users
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:128 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_id |
否 |
String |
主机ID 最小长度:0 最大长度:128 |
user_name |
否 |
String |
账号名称 最小长度:0 最大长度:32 |
host_name |
否 |
String |
主机名称 最小长度:0 最大长度:128 |
private_ip |
否 |
String |
服务器私有IP 最小长度:0 最大长度:128 |
login_permission |
否 |
Boolean |
是否允许登录 |
root_permission |
否 |
Boolean |
是否有root权限 |
user_group |
否 |
String |
主机用户组 最小长度:0 最大长度:128 |
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 最小长度:0 最大长度:128 |
limit |
否 |
Integer |
每页显示数量 最小值:10 最大值:200 缺省值:10 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 最小值:0 最大值:2000000 缺省值:0 |
category |
否 |
String |
类别,默认为host,包含如下:
最小长度:0 最大长度:64 |
part_match |
否 |
Boolean |
是否模糊匹配,默认false表示精确匹配 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
账号总数 最小值:0 最大值:10000 |
data_list |
Array of UserResponseInfo objects |
账号信息列表 数组长度:0 - 10000 |
参数 |
参数类型 |
描述 |
---|---|---|
agent_id |
String |
Agent ID 最小长度:1 最大长度:128 |
host_id |
String |
主机ID 最小长度:1 最大长度:128 |
host_name |
String |
服务器名称 最小长度:1 最大长度:128 |
host_ip |
String |
服务器ip 最小长度:1 最大长度:128 |
user_name |
String |
用户名 最小长度:1 最大长度:128 |
login_permission |
Boolean |
是否有登录权限 |
root_permission |
Boolean |
是否有root权限 |
user_group_name |
String |
用户组 最小长度:1 最大长度:128 |
user_home_dir |
String |
用户目录 最小长度:1 最大长度:256 |
shell |
String |
用户启动shell 最小长度:1 最大长度:128 |
recent_scan_time |
Long |
最近扫描时间 最小值:0 最大值:4070880000000 |
container_id |
String |
容器id 最小长度:1 最大长度:128 |
container_name |
String |
容器名称 最小长度:1 最大长度:256 |
请求示例
默认查询账号为daemon的服务器列表
GET https://{endpoint}/v5/{project_id}/asset/users?user_name=daemon
响应示例
状态码: 200
账号信息列表
{ "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代码示例
SDK代码示例如下。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
账号信息列表 |
错误码
请参见错误码。